name: Stedi Vocabulary description: Domain vocabulary extracted from Stedi OpenAPI specifications covering EDI, healthcare clearinghouse, claims, eligibility, enrollment, and event management terms. url: https://www.stedi.com/docs version: 1.0.0 created: '2026-06-12' tags: [] terms: - name: AccessDeniedException description: The server response for authorization failure. source: healthcare type: object - name: AccessDeniedExceptionResponseContent description: The server response for authorization failure. source: core type: object - name: AccountNumberQualifier description: Identifies the type of bank account being used for electronic payment transactions. This specifies whether the account is a checking (demand deposit) or savings account. source: healthcare type: string - name: AdditionalIdentificationDependent description: Use this object when you need to provide an additional identification number for the dependent. This is rarely required for standard eligibility checks. source: healthcare type: object - name: AdditionalIdentificationSubscriber description: 'Use this object when you need to provide an identification number other than or in addition to the subscriber''s member ID. For example, you may provide the patient account number. Don''t include the health insurance claim number or the medicaid recipient ID number here unless they are different from the member ID.' source: healthcare type: object - name: AdditionalInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: Address description: Schema type from the Stedi healthcare API source: healthcare type: object - name: AdjustmentGroupCode description: Code identifying the general category of payment adjustment. Can be set to `CO` - Contractual Obligations, `CR` - Correction and Reversals, `OA` - Other Adjustments, `PI` - Payor Initiated Reductions, or `PR - Patient Responsibility. source: healthcare type: string - name: Adjustments description: Provider adjustment details including reason codes and amounts. source: healthcare type: object - name: AdmittingDiagnosis description: Schema type from the Stedi healthcare API source: healthcare type: object - name: AdmittingDiagnosisQualifierCode description: Code identifying the type of admitting diagnosis code used. Can be set to `ABJ` - International Classification of Diseases Clinical Modification (ICD-10-CM) Admitting Diagnosis or `BJ` - International Classification of Diseases Clinical Modification (ICD-9-CM) Admitting Diagnosis. Note that ICD-9 is deprecated and cannot be used in new claims. source: healthcare type: string - name: AggregationPreference description: "Preference for how the payer should group 835 Electronic Remittance\ \ Advice (ERA) transactions. Only set this property for 835 ERA enrollments.\n\ \ - If you include this property for a non-ERA enrollment, Stedi rejects the\ \ enrollment request with an HTTP `400` error.\n - If the payer doesn't support\ \ the requested aggregation type, Stedi rejects the enrollment request with an\ \ HTTP `400` error.\n - If not set, Stedi automatically selects a default based\ \ on the payer's supported aggregation types and the available identifiers for\ \ the provider.\n - Stedi will attempt to enroll with this preference, but it's\ \ not guaranteed. Each payer has its own restrictions and behaviors." source: enrollment type: object - name: AllEnrolledProviderFields description: Complete provider information including both read-only and mutable fields. source: enrollment type: object - name: AmbulanceCertification description: Required when the claim involves ambulance transport services. source: healthcare type: object - name: AmbulanceCertificationCertificationConditionIndicator description: Code indicating whether there is an ambulance certification. source: healthcare type: string - name: AmbulanceCertificationConditionCodesItem description: Code indicating the condition of the patient at the time of transport. You can provide up to five codes. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#ambulance-certification-condition-codes) for a complete list. source: healthcare type: string - name: AmbulanceTransportInformation description: Information about the ambulance service provided to the patient. source: healthcare type: object - name: AmbulanceTransportReasonCode description: Code indicating the reason for ambulance transport. For example, `A` - Patient was transported to nearest facility for care of symptoms, complaints, or both. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#ambulance-transport-reason-codes) for a complete list. source: healthcare type: string - name: ApplicationModes description: 'The type of data in the request. This is either `production` when you send a request with a standard API key or `test` when you send a request in test mode with a [test API key](https://www.stedi.com/docs/api-reference/index#api-key-types). The `information` value is not currently used. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: Artifact description: Schema type from the Stedi core API source: core type: object - name: ArtifactModel description: The model of the artifact, which indicates the type of process or operation it represents. For example, an execution artifact represents a file that was processed, a fragment artifact represents a part of a larger transaction, and a fault artifact represents an error that occurred during processing. source: core type: string - name: ArtifactType description: The format of the artifact. source: core type: string - name: ArtifactUsage description: 'The type of data the artifact contains. For example, an input artifact represents the original data Stedi received before processing, while an output artifact represents the processed data. For example, for an inbound 835 ERA from a payer, the input artifact would be the original X12 EDI, and the output artifact would be the JSON representation of the ERA.' source: core type: string - name: AssistantSurgeon description: 'Information about the assistant surgeon who rendered the care. Use this object when the rendering providers provided these services in the role of the assistant surgeon. This should be an individual, not an organization, and you should supply at least the surgeon''s `lastName`, `taxonomyCode`, and an identifier, which is typically the `npi`.' source: healthcare type: object - name: AttachmentReportTypeCode description: Code indicating the title or contents of a document, report or supporting item. For example, `08` - Plan of Treatment or `CT` - Certification. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#attachment-report-type-codes) for a complete list. source: healthcare type: string - name: AttachmentsResponseMetadata description: Metadata from Stedi about the request. source: claims type: object - name: Attending description: 'Information about the individual who has overall responsibility for the patient''s medical care and treatment reported in the claim. This information is required when the claim contains any services other than non-scheduled transportation claims. This provider should be an individual, not an organization, and you should supply at least the provider''s `lastName` and an identifier, which is typically the `npi`.' source: healthcare type: object - name: AuthOrCertIndicator description: 'Code indicating whether the benefit is subject to prior authorization or certification. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: BadRequestException description: The server cannot process the request due to an apparent client error. source: healthcare type: object - name: BadRequestExceptionResponseContent description: The server cannot process the request due to an apparent client error. source: core type: object - name: BenefitRelatedEntityIdentification description: 'Code identifying the type of value provided in `entityIdentificationValue`. For example, `FI` - Federal Taxpayer''s Identification Number. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: BenefitsAdditionalInformation description: Identifying information specific to this type of benefit. source: healthcare type: object - name: BenefitsDateInformation description: "Dates associated with the benefits.\n - This is where you can find\ \ benefit-specific eligibility dates, if provided. These dates override dates\ \ provided in `planDateInformation` for this benefit type.\n - This is where\ \ the payer may specify the last time the service was rendered (`latestVisitOrConsultation`),\ \ which you can use to determine whether the patient has already reached the allowed\ \ frequency, if applicable. For example, this object could contain the date when\ \ the patient received their last dental cleaning.\n - These dates only apply\ \ to the `benefitsInformation` object in which this `benefitsDateInformation`\ \ is provided." source: healthcare type: object - name: BenefitsInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: BenefitsInformationCode description: 'The code indicating the type of benefits information. Visit [Eligibility and benefit codes](https://www.stedi.com/docs/healthcare/eligibility-active-coverage-benefits#benefit-type-codes) for more information. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: BenefitsInformationCoverageLevelCode description: "Code indicating the level of coverage for the patient. \n\nThis will\ \ either be `CHD` - Children Only, `DEP` - Dependents Only, `ECH` - Employee and\ \ Children, `EMP` - Employee Only, `ESP` - Employee and Spouse, `FAM` - Family,\ \ `IND` - Individual, `SPC` - Spouse and Children, `SPO` - Spouse Only, or `Unknown`.\n\ \nPayers may sometimes return other non-compliant values." source: healthcare type: string - name: BenefitsInformationCoverageLevelName description: 'The full name of the coverage level code. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: BenefitsInformationName description: 'The full name of the benefits information code. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: BenefitsRelatedEntity description: 'Identify another entity associated with the eligibility or benefits. This could be a provider, an individual, an organization, or another payer. This array is commonly used to designate the patient''s primary care provider (PCP), another organization that handles a specific carveout benefit type, or another health plan for the patient (coordination of benefits scenarios). This is where information for a crossover carrier such as Medicaid or Medicare is provided, if it''s applicable to the patient and the payer supports it.' source: healthcare type: object - name: BenefitsRelatedEntityRelationshipCode description: 'Code specifying the relationship between the entity and the patient. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: BenefitsServiceDelivery description: The delivery or usage pattern for the benefits. source: healthcare type: object - name: BenefitsServiceDeliveryQuantityQualifier description: 'The name of the `quantityQualifierCode`. For example, `Days`. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: BenefitsServiceDeliveryQuantityQualifierCode description: 'Code specifying the type of quantity. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: Billing description: 'Information about the billing provider. - You must provide an `address` that is a physical location such as the office where care is delivered or an administrative facility. - For tax identification, you must include either the provider''s Social Security Number (SSN) in the `ssn` property _or_ their Employer Identification Number (EIN) in the `employerId` property, but not both. - If the billing provider has an NPI, you must include it in the `npi` property. If the billing provider does not have an NPI, you must include either the `commercialNumber` or the `locationNumber` for identification. Some payers may require the `npi` **and** either the `commercialNumber` or the `locationNumber` as a secondary identifier. - Some solo providers may use their SSN as their EIN. In this case, submit the SSN in the `ssn` property and leave the `employerId` property blank.' source: healthcare type: object - name: BillingProviderType description: Defines the billing provider type. source: healthcare type: string - name: BusinessContactInformation description: A person or office to whom administrative communications should be directed. source: healthcare type: object - name: BusinessIdentifier description: Schema type from the Stedi core API source: core type: object - name: COB description: Schema type from the Stedi healthcare API source: healthcare type: object - name: COBBenefitsDateInformation description: Dates associated with the benefits. Dates listed only apply to the `benefitsInformation` object in which this benefitsDateInformation is provided. source: healthcare type: object - name: COBBenefitsInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: COBBenefitsInformationName description: The full name of the benefits information code. source: healthcare type: string - name: COBBenefitsRelatedEntity description: Schema type from the Stedi healthcare API source: healthcare type: object - name: COBDependent description: 'A dependent for which you want to check coordination of benefits. - An individual qualifies as a dependent when they are listed as a dependent on the subscriber''s insurance plan AND the payer cannot uniquely identify them through information outside the subscriber''s policy. For example, if the dependent has their own member ID number, you should identify them in the `subscriber` object instead. - The demographic information you provide **must** patch the payer''s data exactly. For example, if the payer has the dependent''s name as `Jonathan Doe`, a COB request for `Jon Doe` will fail because the name doesn''t match the payer''s records.' source: healthcare type: object - name: COBEncounter description: 'Information about the encounter. - You can submit COB checks with the `30` service type code for Health Benefit Plan Coverage. This is the broadest service type code that covers all medical services and subtypes included in the patient’s health plan. - The service dates you provide **must** be within the past 2 years. COB checks don''t support requests with dates outside of this range. - Don''t send service dates that are in the future. Future service dates typically result in errors from the payer. - If you don''t specify a service date (either a single day or a range of dates), Stedi defaults to using the current date.' source: healthcare type: object - name: COBMetaData description: Schema type from the Stedi healthcare API source: healthcare type: object - name: COBPayer description: Schema type from the Stedi healthcare API source: healthcare type: object - name: COBPlanDateInformation description: 'Dates associated with the patient''s health plan coverage. This information is used to determine their eligibility for benefits. - The provided dates apply to every benefit within the patient''s health plan unless specifically noted within a `benefitsInformation[].benefitsDateInformation` object. - If the payer sends back date(s) that are different for the subscriber and dependents, Stedi includes only the dates for the dependent in this object and omits the subscriber''s date(s). Dependents can have different coverage dates than the subscriber due to qualifying life events, such as starting a new job or passing the age limit for coverage through their parent''s plan.' source: healthcare type: object - name: COBProvider description: Information about the entity requesting the coverage. source: healthcare type: object - name: COBResponseBenefitsInformationCode description: The code indicating the type of benefits information. Can be `1` - Active Coverage, `6` - Inactive, `R` - Other or Additional Payor, or `V` - Cannot Process. source: healthcare type: string - name: COBResponseBenefitsInformationSubscriber description: Schema type from the Stedi healthcare API source: healthcare type: object - name: COBResponseDependent description: Information about the dependent listed in the original COB request. source: healthcare type: object - name: COBResponseProvider description: Information about the entity that submitted the original eligibility check request. This may be an individual practitioner, a medical group, a hospital, or another type of healthcare provider. source: healthcare type: object - name: COBResponseServiceTypeCode description: Code identifying the type of services included in a `benefitsInformation` object. source: healthcare type: string - name: COBResponseServiceTypeCodeName description: The names of the `benefitsInformation[].serviceTypeCodes` included in the response. source: healthcare type: string - name: COBResponseSubscriber description: Information about the primary policyholder for the insurance plan listed in the COB request. source: healthcare type: object - name: COBServiceTypeCode description: The service type code for the encounter. If not provided, the default value is `30`. source: healthcare type: string - name: COBSubscriber description: "The primary policyholder for the insurance plan _or_ a dependent with\ \ a unique member ID. If a dependent has a unique member ID, include their information\ \ here and leave `dependent` empty.\n\n\n\nThe demographic information you provide\ \ **must** match the payer's data exactly. For example, if the payer has the subscriber's\ \ name as `Jonathan Doe`, a COB request for `Jon Doe` will fail because the name\ \ doesn't match the payer's records. Also note that:\n - Any prefix on the member's\ \ card is considered part of the `memberID` used for the search.\n - Mismatches\ \ in the `memberId` are one of the most common causes of `Member Not Found` errors.\ \ We strongly recommend first performing an [Eligibility Check](https://www.stedi.com/docs/healthcare/api-reference/post-healthcare-eligibility)\ \ and using the `memberId` in the response to populate your COB check.\n - We\ \ recommend including the `ssn` property in addition to the `memberId` if possible.\ \ This allows Stedi to do an additional search for the patient when the `memberId`\ \ doesn't return a match.\n - Stedi can identify coverage overlap for the same\ \ payer if the member ID differs between the two coverages." source: healthcare type: object - name: CertificationConditionCodeAppliesIndicator description: Code indicating whether an EPSDT referral was given to the patient. Can be set to `N` - No or `Y` - Yes. source: healthcare type: string - name: CertificationTypeCode description: Code indicating the type of certification. Can be set to `I` - Initial, `R` - Renewal, or `S` - Revised. source: healthcare type: string - name: Claim description: Information about the claim and its status. source: healthcare type: object - name: ClaimAcknowledgmentDetails description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimAcknowledgmentDetailsServiceProvider description: Information about the service provider. source: healthcare type: object - name: ClaimAcknowledgmentPayer description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimAcknowledgmentServiceIdQualifierCode description: Code identifying the source of the procedure code in claim status reports. source: healthcare type: string - name: ClaimAcknowledgmentServiceIdQualifierCodeValue description: Human-readable descriptions for service ID qualifier codes. source: healthcare type: string - name: ClaimAcknowledgmentServiceLines description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimAcknowledgmentServiceLinesService description: Information about the service provided. source: healthcare type: object - name: ClaimAcknowledgmentTransactions description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimAcknowledgmentTransactionsProvider description: Information about the provider receiving the claim status details. source: healthcare type: object - name: ClaimAdjustment description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimAdjustmentDetails description: The adjustment reason codes and amounts. You can include up to six objects in this array to describe a single adjustment group code. source: healthcare type: object - name: ClaimAdjustmentGroupCode description: Defines the category of adjustment reason codes that explain why a claim payment was adjusted. These codes categorize adjustments into contractual obligations, payer-initiated reductions, patient responsibilities, and other adjustments. source: healthcare type: string - name: ClaimAdjustments description: Claim-level adjustments with reason codes and amounts. source: healthcare type: object - name: ClaimAttachmentReference description: Information about the claim attachment. source: claims type: object - name: ClaimCodeInformation description: Supply information specific to hospital claims, such as the priority of the admission. source: healthcare type: object - name: ClaimContractInformation description: Required when the submitter is contractually obligated to supply this information on post-adjudicated claims. source: healthcare type: object - name: ClaimContractInformationContractTypeCode description: A code identifying the type of contract. Can be set to `01` - Diagnosis Related Group (DRG), `02` - Per Diem, `03` - Variable Per Diem, `04` - Flat, `05` - Capitated, `06` - Percent, or `09` - Other. source: healthcare type: string - name: ClaimDateInformation description: You must provide at least one date related to the claim. For example, the date on which the patient was admitted to the hospital. source: healthcare type: object - name: ClaimFilingCode description: 'A code identifying the type of claim. For example `DS` - Disability. - Use `OF` when submitting Medicare Part D claims. - Use `ZZ` when you don''t know the type of insurance. - Some payers reject claims with invalid codes. If you''re not sure which code to use, we recommend running a [real-time eligibility check](https://www.stedi.com/docs/healthcare/api-reference/post-healthcare-eligibility) and using the value returned in the most relevant `benefitsInformation.insuranceTypeCode` property. Note that the eligibility response uses a different code list than claims, so you may need to map that code value to the appropriate claim filing code. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#claim-filing-indicator-codes) for a complete list.' source: healthcare type: string - name: ClaimFilingIndicatorCode description: A code identifying the type of claim. For example `DS` - Disability. Use `OF` when submitting Medicare Part D claims. Use `ZZ` when you don't know the type of insurance. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#claim-filing-indicator-codes) for a complete list. source: healthcare type: string - name: ClaimFrequencyCode description: 'Identify the type of claim. Can be set to: `1` - indicates an original claim, `7` - Indicates the new claim is a replacement or correction, `8` - Indicates the claim is void or canceled' source: healthcare type: string - name: ClaimIdentifier description: "A code specifying the type of transaction. Defaults to `CH` if not\ \ provided.\n - `31`: Only for use by state Medicaid agencies performing post\ \ payment recovery.\n - `CH`: Use when the transaction contains only fee for\ \ service claims or claims with at least one chargeable line item. Also use when\ \ it's not clear whether a transaction contains claims or capitated encounters,\ \ or if the transaction contains a mix of claims and capitated encounters.\n \ \ - `RP`: Use for capitated encounters. Also use when the transaction is being\ \ sent to an entity for purposes other than adjudication of a claim. For example,\ \ when you're sending the claim to a state health agency that is using the claim\ \ for health data reporting purposes." source: healthcare type: string - name: ClaimInformation description: "Information about the healthcare claim. \n\nNote that the objects\ \ and properties marked as **required** are required for all claims, while others\ \ are conditionally required, depending on type of claim and claim circumstances.\ \ For example, you must always provide the patient's diagnosis codes in the `healthCareCodeInformation`\ \ object, but you only need to provide the `otherSubscriberInformation` object\ \ in coordination of benefits scenarios. When you include a conditionally required\ \ object, you must provide all of its required properties." source: healthcare type: object - name: ClaimInformationBenefitsAssignmentCertificationIndicator description: A code indicating whether the patient or an authorized person has authorized the plan to remit payment directly to the provider. Use `W` when the patient refuses to assign benefits. Can be set to `N` - No (Payment should go to the patient), `Y` - Yes (Payment should go directly to the provider), or `W` - Not Applicable (use when patient refuses to assign benefits). source: healthcare type: string - name: ClaimInformationConditionCodesItem description: Schema type from the Stedi healthcare API source: healthcare type: string - name: ClaimInformationRelatedCausesCodeItem description: Code identifying an accompanying cause of an illness, injury or an accident. Can be set to `AA` - Auto Accident, `EM` - Employment, or `OA` - Other Accident. source: healthcare type: string - name: ClaimLevelEntityIdentifierCode description: Entity identifier code for claim level in claim status reports source: healthcare type: string - name: ClaimLevelEntityIdentifierCodeValue description: Human-readable descriptions for claim level entity identifier codes source: healthcare type: string - name: ClaimLevelStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimNote description: Comments or special instructions related to the claim. Contains information required to substantiate the medical treatment that isn't provided elsewhere in the claim. source: healthcare type: object - name: ClaimNotes description: Free-form information to substantiate the medical treatment that isn't provided elsewhere in the claim submission. Also used to provide narrative information from the forms Home Health Certification and Plan of Treatment or Medical Update and Patient Information, as needed to substantiate home health services. You can provide up to 10 strings in this array. source: healthcare type: object - name: ClaimPaymentAdviceFilingIndicatorCode description: Identifies the type of health plan or insurance coverage under which the claim was filed. These codes indicate the specific type of insurance arrangement, government program, or coverage type that applies to the claim. source: healthcare type: string - name: ClaimPaymentAdvicePayer description: Information about the payer. source: healthcare type: object - name: ClaimPaymentAdvicePayerAddress description: Address information for the payer. source: healthcare type: object - name: ClaimPaymentAdviceResponse description: The complete claim payment advice response from the payer. source: healthcare type: object - name: ClaimPaymentAdviceResponseFinancialInformation description: Information about a payment, including the payment method, payment amount, and account details for both the sender and receiver. source: healthcare type: object - name: ClaimPaymentAdviceResponsePaymentAndRemitReassociationDetails description: Information to uniquely identify the transaction and help with reassociating payments and remittances that have been separated. source: healthcare type: object - name: ClaimPaymentAdviceServiceLines description: Information about specific service lines in the claim payment advice. source: healthcare type: object - name: ClaimPaymentAdviceServiceLinesRenderingProviderInformation description: Identifiers for the provider who rendered this service. source: healthcare type: object - name: ClaimPaymentAdviceServiceLinesServiceIdentification description: Additional identifiers related to the service line. source: healthcare type: object - name: ClaimPaymentAdviceServiceLinesServicePaymentInformation description: Payment and control information about a provider for a particular service. source: healthcare type: object - name: ClaimPaymentAdviceServiceLinesServiceSupplementalAmounts description: Information about the service supplemental amount. All values are expressed as decimals. source: healthcare type: object - name: ClaimPaymentAdviceServiceLinesServiceSupplementalQuantities description: Additional quantity information about the service. All values are expressed as decimals. source: healthcare type: object - name: ClaimPaymentEnrollmentProcess description: Details about the enrollment process for Electronic Remittance Advice (ERAs). source: healthcare type: object - name: ClaimPricingInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimPricingInformationProductOrServiceIDQualifier description: Code identifying the type of product or service ID used. Can be set to `ER` - Jurisdiction Specific Procedure and Supply Codes, `HC` - Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes, `HP` - Health Insurance Prospective Payment System (HIPPS) Skilled Nursing Facility Rate Code, `IV` - Home Infusion EDI Coalition (HIEC) Product/Service Code, or `WK` - Advanced Billing Concepts (ABC) Codes. Note that ABC codes are deprecated and should not be used in new claims. If you provide this property, you must also provide `repricedApprovedHCPCSCode` Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#product-or-service-id-qualifier-codes) for a complete list and additional usage notes. source: healthcare type: string - name: ClaimPricingRepricingInformation description: Repricing information to be completed by repricers, not providers. For capitated encounters, pricing or repricing information usually is not applicable and is provided to qualify other information within the claim. source: healthcare type: object - name: ClaimReference description: Information about the claim. source: healthcare type: object - name: ClaimServiceFacilityLocation description: 'Required when the location for the service is different from the billing provider''s address. The purpose of this object is to identify specifically where the service was rendered. This can be healthcare facilities, such as surgical centers or reference labs, OR the patient''s address when services were rendered in their home. - Only include this object when the service facility location is **different** from the billing provider''s address. If you include this object when the address is the same, Stedi omits all of the service facility location information from the claim submission, including the name and any identifiers. - 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. - Don''t use this object when reporting ambulance services - use `ambulancePickupLocation` and `ambulanceDropoffLocation` instead. - Sometimes the billing provider is an actual physician group that is located at the same address as a hospital, but is in fact a separate entity. In this case, you can differentiate the service facility location by including the specific suite or building number of the physician group. This ensures that the service facility location is different from the billing provider''s address and is reported accurately.' source: healthcare type: object - name: ClaimServiceFacilityLocationSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimStatusCode description: Indicates the status of the claim after adjudication by the payer. These codes determine whether the claim was processed as primary, secondary, tertiary, denied, forwarded to other payers, or represents special processing situations like reversals or predeterminations. source: healthcare type: string - name: ClaimStatusContactInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimStatusEncounter description: "Information about the referenced claim or claims for which you want\ \ to retrieve status information.\n - We recommend supplying a date range that\ \ is at least plus or minus 7 days from the date of the services listed in the\ \ claim, using the `beginningDateOfService` and `endDateOfService` properties.\ \ The payer may have stored a different date for the encounter than the one in\ \ your records, so providing a date range increases the likelihood that the payer\ \ will find a match.\n - Don't submit future dates - only submit date ranges\ \ up to and including today's date. Some payers reject requests containing future\ \ service dates." source: healthcare type: object - name: ClaimStatusInquiryEnrollmentProcess description: Details about the enrollment process for real-time claim status requests. source: healthcare type: object - name: ClaimStatusPayer description: Information about the payer listed in the referenced claim. source: healthcare type: object - name: ClaimStatusProviderType description: Identifies the type of provider related to the referenced healthcare claim. source: healthcare type: string - name: ClaimStatusRawX12RequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimStatusRawX12ResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimStatusRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimStatusResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimStatusResponseMeta description: Metadata about the response. source: healthcare type: object - name: ClaimStatusSubscriber description: 'Information about the subscriber listed in the referenced claim. - You must set both the `dateOfBirth` and `gender` properties when the subscriber is the patient unless the gender is unknown. Stedi determines that the subscriber is the patient when the `dependent` object is not included in the request. - If either `dateOfBirth` or `gender` is set, you must include both properties unless the gender is unknown.' source: healthcare type: object - name: ClaimStatusSubscriberGender description: A code indicating the subscriber's gender. If the claim set the subscriber's gender to `U` for unknown, you should omit this property from the claim status request. source: healthcare type: string - name: ClaimSupplementalInformation description: Additional information or documentation required for the claim. This is where you can include information about [attachments](https://www.stedi.com/docs/healthcare/submit-claim-attachments), if applicable. source: healthcare type: object - name: ClaimsAddress description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsClaimStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsContactInformation description: You must include at least one communication method (phone, fax, or email) in this object. source: healthcare type: object - name: ClaimsDiagnosisTypeCode description: Code indicating the specific industry code list. Can be set to `ABK` - International Classification of Diseases Clinical Modification (ICD-10-CM) Principal Diagnosis or `ABF` - International Classification of Diseases Clinical Modification (ICD-10-CM) Diagnosis. source: healthcare type: string - name: ClaimsError description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsExceptionCode description: Code specifying the exception reason for consideration of out-of-network health care services. This is the reason generated by the third-party health organization. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#exception-codes-2) for a complete list. source: healthcare type: string - name: ClaimsHealthCareInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsIndividualRelationshipCode description: Code identifying the relationship to the person insured. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#individual-relationship-codes) for a complete list. source: healthcare type: string - name: ClaimsPayer description: Information about the payer for the submitted claim. source: healthcare type: object - name: ClaimsProvider description: 'The entity responsible for overseeing the rendering provider and the care reported in this claim. Applies when the rendering provider is supervised by a physician. Use when the provider applies to the entire claim, not just a specific service line. This should be an individual, not an organization, and you should supply at least the provider''s `lastName` and an identifier, which is typically the `npi`.' source: healthcare type: object - name: ClaimsRawX12SubmissionRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsRawX12SubmissionResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsServiceLineReferringProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsServiceLineRenderingProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsServiceLineSupervisingProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsSubmissionRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsSubmissionResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ClaimsWarning description: 'Warnings indicate issues that may cause some payers to reject the claim. Stedi doesn’t reject claims with warnings only - a response with warnings but no errors means Stedi still submitted the claim. If you receive warnings, we recommend closely monitoring 277CA responses from the payer for rejections. If the claim is rejected, we recommend fixing the issues identified in the warnings before resubmitting.' source: healthcare type: object - name: CodeCategory description: Identifies the category to which the `conditionCode` applies. Can be set to `E1` - Spectacle Lenses, `E2` - Contact Lenses, or `E3` - Spectacle Frames. source: healthcare type: string - name: CodeListQualifierCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: CommunicationMode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: ComponentsSchemasClaimStatus description: The status, required action, and paid information of a claim or service line. source: healthcare type: object - name: CompositeDiagnosisCodePointers description: 'Diagnosis code pointers in order of importance to this service line. These pointers are an index to the ICD-10-CM codes you included in the `claimInformation.healthCareCodeInformation` object array. The pointer values can be from 1 to 12 (integer numbers). - You **must** set at least one pointer for the primary diagnosis. Then, you can add up to three additional pointers (up to four in total). - The number of pointers cannot exceed the number of diagnosis codes in the `claimInformation.healthCareCodeInformation` object array. For example, if you only supplied one diagnosis code, then the only valid pointer value is 1. - Don''t put ICD-10-CM codes here - they belong in `claimInformation.healthCareCodeInformation`.' source: healthcare type: object - name: CompositeMedicalProcedureIdentifier description: Identifies relevant medical procedures by their standard codes and modifiers (if applicable). source: healthcare type: object - name: ConditionIndicator description: Code indicating the condition of the certificate. Can be set to `38` - Certification signed by the physician is on file at the supplier's office or `ZV` - Replacement Item. source: healthcare type: string - name: ConditionIndicatorCode description: A second code indicating the condition of the certificate. Can be set to `38` - Certification signed by the physician is on file at the supplier's office or `ZV` - Replacement Item. source: healthcare type: string - name: ConditionIndicatorDurableMedicalEquipment description: Required when a Durable Medical Equipment Regional Carrier Certificate of Medical Necessity (DMERC CMN) or a DMERC Information Form (DIF), or Oxygen Therapy Certification is included on this service line and the information is necessary for adjudication. source: healthcare type: object - name: ConditionIndicatorDurableMedicalEquipmentCertificationConditionIndicator description: Code indicating whether there is a certification. Can be set to `N` - No or `Y` - Yes. source: healthcare type: string - name: ConditionInformation description: HI source: healthcare type: object - name: Confidence description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ConfidenceLevel description: Schema type from the Stedi healthcare API source: healthcare type: string - name: ConflictExceptionResponseContent description: Exception returned when a resource conflict is detected, such as a duplicate submission already in progress. source: healthcare type: object - name: ContactInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ContactInformationOrderingProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ContactInformationSubscriberDependent description: Only use this object for payer administrative contacts on property and casualty claims. Otherwise, you shoudn't include contact information here. If you include this object, you must supply at least one communication method (phone, fax, or email). source: healthcare type: object - name: ContactMethod description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ContactMethods description: Schema type from the Stedi healthcare API source: healthcare type: object - name: Contacts description: Contacts source: healthcare type: object - name: ContentType description: Allowed content types for claim attachments. source: claims type: string - name: ContractInformation description: Required when the submitter is contractually obligated to supply this information on post-adjudicated claims. source: healthcare type: object - name: ContractInformationContractTypeCode description: Code indicating the type of contract. Can be set to `01` - Diagnosis Related Group (DRG), `02` - Per Diem, `03` - Variable Per Diem, `04` - Flat, `05` - Capitated, `06` - Percent, or `09` - Other. source: healthcare type: string - name: ConvertReport277ResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ConvertReport835ResponseContent description: Transaction response structure for claim payment advice. source: healthcare type: object - name: CoordinationOfBenefits400ErrorResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: CoordinationOfBenefitsEnrollmentProcess description: Details about the enrollment process for coordination of benefits (COB) checks. source: healthcare type: object - name: CoordinationOfBenefitsRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: CoordinationOfBenefitsResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: CopayStatusCode description: Code indicating whether co-payment requirements were met. Can be set to `O` - Copay exempt. source: healthcare type: string - name: CoreCharacterSet description: When generating EDI, the character set determines the set of characters allowed in the EDI message. Characters outside of the specified set (after applying any repairs specified in RepairOptions) will result in an error. source: core type: string - name: CoreConnectionType description: The type of connection used for file delivery. source: core type: string - name: CorrectedPriorityPayer description: Information about the corrected priority payer. Used when the current payer believes that another payer has priority for making a payment and the claim is not being automatically transferred to that payer. source: healthcare type: object - name: CoverageType description: The types of insurance coverage that a payer can provide. Used to indicate whether a payer supports transactions for medical coverage, dental coverage, vision coverage, or a combination of these. source: healthcare type: string - name: CreateClaimAttachmentFileRequestContent description: Request a pre-signed URL to upload a claim attachment file. source: claims type: object - name: CreateClaimAttachmentFileResponseContent description: Receive the attachment ID and upload URL. source: claims type: object - name: CreateEnrollmentDocumentDownloadResponseContent description: Response containing the document ID and pre-signed URL for download. source: enrollment type: object - name: CreateEnrollmentDocumentUploadRequestContent description: Input for CreateDocumentUpload. source: enrollment type: object - name: CreateEnrollmentDocumentUploadResponseContent description: Response containing the enrollment ID, document ID, and pre-signed URL. source: enrollment type: object - name: CreateEnrollmentRequestContent description: Input for CreateEnrollment. source: enrollment type: object - name: CreateEnrollmentResponseContent description: Output containing the created enrollment details. source: enrollment type: object - name: CreateOutboundFragmentRequestContent description: Schema type from the Stedi core API source: core type: object - name: CreateOutboundFragmentResponseContent description: Schema type from the Stedi core API source: core type: object - name: CreatePartnershipOutboundTransactionRequestContent description: Schema type from the Stedi core API source: core type: object - name: CreatePartnershipOutboundTransactionResponseContent description: Schema type from the Stedi core API source: core type: object - name: CreateProviderRequestContent description: Information about the provider you want to add to your account. The provider **must** have a unique NPI from other providers in your account. source: enrollment type: object - name: CreateProviderResponseContent description: Output containing the created provider details. source: enrollment type: object - name: CreateTransactionGroupRequestContent description: Schema type from the Stedi core API source: core type: object - name: CreateTransactionGroupResponseContent description: Schema type from the Stedi core API source: core type: object - name: CreditDebitFlagCode description: Indicates whether a financial transaction represents a credit or debit to the provider's account. Used to specify the direction of money flow in payment transactions. source: healthcare type: string - name: CrossoverCarrier description: Information about the crossover carrier. The crossover carrier is defined as any payer to which the claim is transferred for further payment after the current payer has finalized it. source: healthcare type: object - name: DateTimePeriodFormatQualifier description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: DelayReasonCode description: Code indicating the reason for the delay in claim submission. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#delay-reason-codes) for a complete list. source: healthcare type: string - name: DeliveryOrCalendarPatternQualifier description: 'The name of the `deliveryOrCalendarPatternCode`. For example, `Last Working Day of Period`. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: DeliveryOrCalendarPatternQualifierCode description: 'Code that specifies the routine shipments, deliveries, or calendar pattern. For example `9` - Last Working Day of Period. Visit [Eligibility code lists](https://www.stedi.com/docs/healthcare/eligibility-code-lists#delivery-frequency-codes) for a complete list. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: DeliveryPatternTimeQualifier description: 'The name of the `deliveryPatternTimeCode`. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: DeliveryPatternTimeQualifierCode description: 'A code specifying the time for routine shipments or deliveries. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: DeliveryReport description: Schema type from the Stedi core API source: core type: object - name: DeliveryReportMetadata description: Metadata about the file delivery. source: core type: object - name: DeliveryReportStatus description: Schema type from the Stedi core API source: core type: string - name: DentalAttachmentReportTypeCode description: Code indicating the title or contents of a document, report or supporting item. For example, `B4` - Referral Form or `DA` - Dental Models. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#attachment-report-type-codes) for a complete list. source: healthcare type: string - name: DentalClaimContractInformation description: Required when the submitter is contractually obligated to supply this information on post-adjudicated claims. source: healthcare type: object - name: DentalClaimDateInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalClaimEnrollmentProcess description: Details about the enrollment process for dental claim submission. source: healthcare type: object - name: DentalClaimInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalClaimSupplementalInformation description: Additional information or documentation required for the claim. This is where you can include information about [attachments](https://www.stedi.com/docs/healthcare/submit-claim-attachments), if applicable. source: healthcare type: object - name: DentalClaimsRawX12SubmissionRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalClaimsRawX12SubmissionResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalClaimsSubmissionRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalClaimsSubmissionResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalContractInformation description: Required when the submitter is contractually obligated to supply this information on post-adjudicated claims. source: healthcare type: object - name: DentalContractInformationContractTypeCode description: Code indicating the type of contract. Can be set to `02` - Per Diem, `03` - Variable Per Diem, `04` - Flat, `05` - Capitated, `06` - Percent, or `09` - Other. source: healthcare type: string - name: DentalContractTypeCode description: A code identifying the type of contract. Can be set to `02` - Per Diem, `03` - Variable Per Diem, `04` - Flat, `05` - Capitated, `06` - Percent, or `09` - Other. source: healthcare type: string - name: DentalDependent description: "Dependent who received the medical care associated with the claim.\n\ \ - If the dependent has their own member ID for the health plan, you should\ \ include the dependent's information in the `subscriber` object instead. To check\ \ whether a dependent has a member ID, submit an [Eligibility Check](https://www.stedi.com/docs/healthcare/api-reference/post-healthcare-eligibility)\ \ to the payer. The payer returns the dependent's member ID in the `dependents.memberId`\ \ property in the response, if present.\n - You must include `address` in this\ \ object when the patient is a dependent." source: healthcare type: object - name: DentalDiagnosisTypeCode description: Code indicating the specific industry code list. Can be set to `ABK` - International Classification of Diseases Clinical Modification (ICD-10-CM) Principal Diagnosis or `ABF` - International Classification of Diseases Clinical Modification (ICD-10-CM) Diagnosis, `TQ` Systemized Nomenclature of Dentistry (SNODENT). source: healthcare type: string - name: DentalHealthCareInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalLineAdjudicationInformation description: Includes service line adjudication information for coordination of benefits between the initial payers of a health care claim and all subsequent payers. source: healthcare type: object - name: DentalLineAdjudicationInformationServiceIdQualifier description: Schema type from the Stedi healthcare API source: healthcare type: string - name: DentalMeasurementUnitCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: DentalMedicareOutpatientAdjudication description: Claim-level data related to the adjudication of Medicare claims not related to an inpatient setting. Required when outpatient adjudication information is reported in the remittance advice _or_ when you need to report remark codes. source: healthcare type: object - name: DentalOtherPayerName description: Details about the other payer. source: healthcare type: object - name: DentalOtherSubscriberInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalOtherSubscriberName description: The person or entity who is the primary policyholder for the other payer's health plan. source: healthcare type: object - name: DentalPlanParticipationCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: DentalReportInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalService description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalServiceIdQualifier description: Schema type from the Stedi healthcare API source: healthcare type: string - name: DentalServiceLine description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalServiceLineAssistantSurgeon description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalServiceLineDateInformation description: Identify specific dates related to the service rendered. source: healthcare type: object - name: DentalServiceLinePricingRepricingInformation description: Repricing information about the line item. This information is completed by repricers, not providers. For capitated encounters, pricing or repricing information usually is not applicable and is provided to qualify other information within the claim. source: healthcare type: object - name: DentalServiceLineReferenceInformation description: Additional identifiers for the service line. source: healthcare type: object - name: DentalServiceLineRenderingProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalServiceLineServiceFacilityLocation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalServiceLineSupervisingProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DentalSpecialProgramCode description: Code indicating the Special Program under which the services rendered to the patient were performed. Used for Medicaid claims only. Can be set to `01` - Early & Periodic Screening, Diagnosis and Treatment (EPSDT) or Child Assessment Program (CHAP), `02` - Physically Handicapped Children's Program, `03` - Special Federal Funding, or `05` - Disability. Codes `02`, `03`, and `05` are used for Medicaid claims only. source: healthcare type: string - name: DentalSubscriber description: 'The person or entity who is the primary policyholder for the health plan _or_ a dependent with their own member ID. - When a dependent has a unique, payer-assigned member ID, treat them as the `subscriber` for the claim submission - include their information here and omit the `dependent` object from the request. Note that the subscriber can be an individual or a business entity. Stedi treats the subscriber as an individual when the request doesn''t contain a value for the `subscriber.organizationName` property. - You must set the `dateOfBirth` and `gender` properties when the subscriber is the patient. Stedi determines that the subscriber is the patient when the `dependent` object is not included in the request. - If either `dateOfBirth` or `gender` is set, you must include both properties. You can either include both properties or neither within a single request. - You must include `address` in this object when the patient is the subscriber. If the patient is a dependent, include address information in the `dependent` object instead.' source: healthcare type: object - name: Dependent description: "Dependent who received the medical care associated with the claim.\n\ \ - If the dependent has their own member ID for the health plan, you should\ \ include the dependent's information in the `subscriber` object instead. To check\ \ whether a dependent has a member ID, submit an [Eligibility Check](https://www.stedi.com/docs/healthcare/api-reference/post-healthcare-eligibility)\ \ to the payer. The payer returns the dependent's member ID in the `dependents.memberId`\ \ property in the response, if present.\n - You must include `address` in this\ \ object when the patient is a dependent." source: healthcare type: object - name: DependentGender description: 'Code indiciating the patient''s gender. Can be set to `F` - Female, `M` - Male, or `U` - Unknown. You should set this property to `U` when the patient declines to answer or does not identify as male or female. Note that some payers may reject the claim if the patient''s gender doesn''t match the gender they have recorded in their member records.' source: healthcare type: string - name: DependentInsuredIndicator description: Indicates the status of the insured. For the dependent, this is always `N`. source: healthcare type: string - name: DependentRelationship description: The name of the `relationToSubscriberCode`. For example, `Child` when the code is `19`. source: healthcare type: string - name: DependentRelationshipCode description: For the dependent, this can be `01` - Spouse, `19` - Child, `20` Employee, `21` - Unknown, `39` - Organ Donor, `40` - Cadaver Donor, `53` - Life Partner, or `G8` - Other Relationship. source: healthcare type: string - name: DetailInfo description: Information about the claim or service line. source: healthcare type: object - name: DfiIdNumberQualifier description: Identifies the type of Depository Financial Institution (DFI) identification number being used. This specifies the format and country of the bank routing information. source: healthcare type: string - name: DiagnosisRelatedGroupInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DiagnosisTypeCode description: "The type of diagnosis code you are providing. You can set to `BK`\ \ - International Classification of Diseases Clinical Modification (ICD-9-CM)\ \ Principal Diagnosis, `ABK` - International Classification of Diseases Clinical\ \ Modification (ICD-10-CM) Principal Diagnosis, `BF`- International Classification\ \ of Diseases Clinical Modification (ICD-9-CM) Diagnosis, or `ABF`- International\ \ Classification of Diseases Clinical Modification (ICD-10-CM) Diagnosis. \n\n\ \ Note that ICD-9 codes are **deprecated** and should no longer be used in eligibility\ \ checks." source: healthcare type: string - name: Direction description: The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner. source: core type: string - name: DiscoveryBenefitsInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DiscoveryPayer description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DiscoveryPlanDateInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DiscoveryResponseDependent description: Common fields shared between subscriber and dependent structures in the eligibility response. source: healthcare type: object - name: DiscoveryResponseProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DiscoveryResponseSubscriber description: Common fields shared between subscriber and dependent structures in the eligibility response. source: healthcare type: object - name: DiscoveryStatus description: Schema type from the Stedi healthcare API source: healthcare type: string - name: DocumentStatus description: Indicates whether the document file has been successfully uploaded to Stedi. source: enrollment type: string - name: DrugIdentification description: To report prescribed drugs and biologics. source: healthcare type: object - name: DrugIdentificationServiceIdQualifier description: Code indicating the source of the drug code or product number. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#drug-identification-product-or-service-id-qualifier-codes) for a complete list. source: healthcare type: string - name: DtpDate description: Schema type from the Stedi healthcare API source: healthcare type: object - name: DurableMedicalEquipmentCertificateOfMedicalNecessity description: Required on claims that include a Durable Medical Equipment Regional Carrier (DMERC) Certificate of Medical Necessity (CMN). source: healthcare type: object - name: DurableMedicalEquipmentCertificateOfMedicalNecessityAttachmentTransmissionCode description: Code indicating the timing, transmission method, or format by which attachments will be sent. Required when the actual attachment is maintained by an attachment warehouse or similar vendor. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#attachment-transmission-codes) for a complete list. Use code `NS` when the paperwork is available on request at the provider's site, but is not being sent with the claim at this time. source: healthcare type: string - name: DurableMedicalEquipmentCertification description: Required when a Durable Medical Equipment Regional Carrier Certificate of Medical Necessity (DMERC CMN) or a DMERC Information Form (DIF) or Oxygen Therapy Certification is included on this service line. source: healthcare type: object - name: DurableMedicalEquipmentService description: Information about durable medical equipment. For example, the rental and purchase price information. source: healthcare type: object - name: EditResponse description: Currently not used. source: healthcare type: object - name: EligibilityAdditionalInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EligibilityCheck400ErrorResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EligibilityCheckDependentError description: When a payer rejects your eligibility check, the response contains one or more `AAA` errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the `subscriber` or `dependent` level include missing or incorrect identifying information and that the payer was unable to locate the patient in their system. [Learn more](https://www.stedi.com/docs/healthcare/eligibility-troubleshooting#payer-aaa-errors) source: healthcare type: object - name: EligibilityCheckDependentErrorCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: EligibilityCheckError description: When a payer rejects your eligibility check, the response contains one or more AAA errors that specify the reasons for the rejection and any recommended follow-up actions. [Learn more](https://www.stedi.com/docs/healthcare/eligibility-troubleshooting#payer-aaa-errors) source: healthcare type: object - name: EligibilityCheckErrorCode description: 'This is a superset of all the possible codes in the sub-loops, as all errors are bubbled up to the top level of the response Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: EligibilityCheckFollowupAction description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: EligibilityCheckOutputValidationErrors description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EligibilityCheckPayerError description: When a payer rejects your eligibility check, the response contains one or more `AAA` errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the `payer` level include issues with payer enrollment and that the payer's system is down or experiencing issues. [Learn more](https://www.stedi.com/docs/healthcare/eligibility-troubleshooting#payer-aaa-errors) source: healthcare type: object - name: EligibilityCheckPayerErrorCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: EligibilityCheckProviderAndMemberFollowupAction description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: EligibilityCheckProviderError description: When a payer rejects your eligibility check, the response contains one or more `AAA` errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the `provider` level include missing or incorrect information and issues with the provider's NPI registration with the payer. [Learn more](https://www.stedi.com/docs/healthcare/eligibility-troubleshooting#payer-aaa-errors) source: healthcare type: object - name: EligibilityCheckProviderErrorCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: EligibilityCheckRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EligibilityCheckResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EligibilityCheckSubscriberError description: When a payer rejects your eligibility check, the response contains one or more `AAA` errors that specify the reasons for the rejection and any recommended follow-up actions. Common reasons for rejection at the `subscriber` or `dependent` level include missing or incorrect identifying information and that the payer was unable to locate the patient in their system. [Learn more](https://www.stedi.com/docs/healthcare/eligibility-troubleshooting#payer-aaa-errors) source: healthcare type: object - name: EligibilityCheckSubscriberErrorCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: EligibilityInquiryEnrollmentProcess description: Details about the enrollment process for eligibility checks. source: healthcare type: object - name: EligibilityMetaDataJSON description: Metadata about the response. Stedi uses this data for tracking and troubleshooting. source: healthcare type: object - name: EligibilityMetaDataRawX12 description: Metadata about the response. Stedi uses this data for tracking and troubleshooting. source: healthcare type: object - name: EligibilityRawX12Check400ErrorResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EligibilityRawX12CheckRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EligibilityRawX12CheckResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EmergencyIndicator description: Code indicating whether the service was related to an emergency. Can be set to `Y` - Yes. An emergency is when the patient requires immediate medical intervention as a result of severe, life threatening, or potentially disabling conditions. source: healthcare type: string - name: EmploymentStatusCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: Encounter description: 'Details about the eligibility or benefit information you are requesting for the patient. - If you don''t specify either `serviceTypeCodes` or a `procedureCode` and `productOrServiceIDQualifier`, Stedi defaults to using `30` (Plan coverage and general benefits) as the only `serviceTypeCodes` value. - You can specify either a single `dateOfService` or a `beginningDateOfService` and `endDateOfService`. The payer defaults to using the current date in their timezone if you don''t include one. - When checking eligibility for today, omit the `dateOfService` property to ensure consistent behavior across payers. - We recommend submitting dates up to 12 months in the past or up to the end of the current month. Payers aren''t required to support dates outside these ranges. However, some payers such as the Centers for Medicare and Medicaid Services (CMS) do support requests for dates further in the future - especially the next calendar month. Check the payer''s documentation to determine their specific behavior.' source: healthcare type: object - name: EncounterProductOrServiceIDQualifier description: Code identifying the type/source of the `procedureCode`. You can set this to `AD` - American Dental Association Codes, `CJ` - Current Procedural Terminology (CPT) Codes, `HC` - Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes, `ID` - International Classification of Diseases, 9th Revision, Clinical Modification (ICD-9-CM) - Procedure, `IV` - Home Infusion EDI Coalition (HIEC) Product/Service Code, `N4` - National Drug Code in 5-4-2 Format, or `ZZ` - Mutually Defined. source: healthcare type: string - name: EncounterReferenceIdentificationQualifier description: The type of information you provided in the `priorAuthorizationOrReferralNumber` property. You can set this to `9F` - Referral Number or `G1` - Prior Authorization Number. source: healthcare type: string - name: EnrolledPayerInput description: The payer you want to enroll with. source: enrollment type: object - name: EnrolledPayerOutput description: Output structure containing payer information in enrollment responses. source: enrollment type: object - name: EnrolledProviderInput description: The provider you want to enroll with the payer. This must be an existing provider record within Stedi. source: enrollment type: object - name: EnrolledTransaction description: Represents the enrollment status for a specific transaction type. source: enrollment type: object - name: EnrolledTransactionsList description: Specifies which transaction types are included in the enrollment. source: enrollment type: object - name: EnrollmentDocument description: A collection of metadata about an enrollment document, including its name, status, last updated date, and the associated enrollment Id. source: enrollment type: object - name: EnrollmentHistoryChangeType description: The type of change recorded in the enrollment history. source: enrollment type: string - name: EnrollmentHistoryEntry description: An update to an enrollment, such as a change in the enrollment's status. This object is experimental and may change in the future. source: enrollment type: object - name: EnrollmentInfo description: Information about enrollment requirements for the payer source: healthcare type: object - name: EnrollmentProcessTimeframe description: Stedi's expected timeframe for completing the transaction enrollment process. `INSTANT` indicates that the enrollment will be in `LIVE` status within minutes of submitting the request. source: healthcare type: string - name: EnrollmentProcessType description: "Whether transaction enrollment is single or multi-step.\n - `ONE_CLICK`\ \ indicates that once you submit the transaction enrollment request, Stedi can\ \ complete the rest of the enrollment process without any further action from\ \ you.\n - `MULTI_STEP` indicates that you must complete additional steps to\ \ finish the enrollment process. Customer support will reach out with clear instructions\ \ explaining how to complete any remaining steps." source: healthcare type: string - name: EnrollmentSource description: The source of the enrollment. source: enrollment type: string - name: EnrollmentStatus description: The status of the enrollment. You can submit enrollments with either `DRAFT` or `STEDI_ACTION_REQUIRED` status - the default is `DRAFT` if not included. Set this to `STEDI_ACTION_REQUIRED` when you're ready for Stedi to begin processing the enrollment. Once an enrollment is `STEDI_ACTION_REQUIRED`, only Stedi can set or update its status. source: enrollment type: string - name: EnrollmentSummary description: Summary of an enrollment with essential fields for list operations. source: enrollment type: object - name: Entity description: Entity descriptions corresponding to Entity Identifier codes. source: healthcare type: string - name: EntityCode description: Entity Identifier codes used to identify organizational entities, physical locations, properties, or individuals. source: healthcare type: string - name: EntityIdentificationCode description: Code identifying the type of `entityIdentificationValue`. source: healthcare type: string - name: EntityIdentifierName description: Identifies the type of `benefitsInformation[].benefitsRelatedEntities`. source: healthcare type: string - name: EntityTypeQualifier description: 'The type of entity. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: EpsdtIndicator description: Code indicating whether there was EPSDT involvement in the service. Can be set to `Y` - Yes. EPSDT is a program that provides comprehensive and preventive health care services for children under age 21 who are enrolled in Medicaid. source: healthcare type: string - name: EpsdtReferral description: Required on Early & Periodic Screening, Diagnosis, and Treatment (EPSDT) claims when the screening service is being billed in this claim. source: healthcare type: object - name: EpsdtReferralConditionCodesItem description: Schema type from the Stedi healthcare API source: healthcare type: string - name: ErrorDetail description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ErrorResponse description: Schema type from the Stedi healthcare API source: healthcare type: object - name: EventEnvironment description: The environment in which an event was produced. source: event-destinations type: string - name: EventPayload description: The event payload, discriminated by object type. Each variant corresponds to a versioned event schema. source: event-destinations type: object - name: EventPayloadObjectType description: Object type discriminator for event payloads. source: event-destinations type: string - name: EventPayloadResourceRef description: A reference to a resource affected by an event. source: event-destinations type: object - name: EventStatus description: The current status of an event. source: event-destinations type: string - name: EventSummary description: A summary representation of an event, returned in list responses. source: event-destinations type: object - name: ExceptionCause description: Schema type from the Stedi core API source: core type: object - name: ExecutionFault description: A failure to process a given file within stedi. source: core type: object - name: ExecutionFaultCode description: A code specifying the reason for the fault. This code appears in the `code` property of the HTTP error response. source: core type: string - name: ExecutionPartnershipProfile description: Schema type from the Stedi core API source: core type: object - name: ExecutionSource description: The source of the file, including the directory where Stedi received it and the file name. source: core type: object - name: ExecutionStatus description: "The status of the execution.\n - You can only retry executions with\ \ a `FAILED` or `IGNORED` status.\n - An execution is `COMPLETED` when Stedi\ \ has finished processing the file with no errors. If the file is an outbound\ \ file, a `COMPLETED` status also means that Stedi successfully delivered it to\ \ the configured connection." source: core type: string - name: ExecutionSummary description: The processed executions that match the request criteria. The `items` array is empty if there are no matching executions. source: core type: object - name: ExportEnrollmentsCsvRequestContent description: Input for ExportEnrollmentsCsv operation. Supports the same filtering options as ListEnrollments (excluding pagination). source: enrollment type: object - name: ExportEnrollmentsCsvResponseContent description: Output containing export results. If no enrollments found, downloadUrl and filename will be undefined and recordCount will be 0. source: enrollment type: object - name: ExportPDF400ErrorResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ExportPDF403ErrorResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ExportPDF404ErrorResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ExportPDFResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ExternalCauseOfInjury description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ExternalCauseOfInjuryPresentOnAdmissionIndicator description: Indicates whether the external cause of injury was present on admission. Can be set to `N` - No (onset did NOT occur prior to admission to the hospital), `Y` - Yes (onset occurred prior to admission to the hospital), `U` - Unknown, or `W` - Not Applicable. source: healthcare type: string - name: ExternalCauseOfInjuryQualifierCode description: Code identifying the type of external cause of injury code used. Can be set to `ABN` - International Classification of Diseases Clinical Modification External Cause of Injury Code or `BN` - International Classification of Diseases Clinical Modification External Cause of Injury Code. Note that ICD-9 is deprecated and cannot be used in new claims. source: healthcare type: string - name: Failure description: Currently not used. source: healthcare type: object - name: FamilyPlanningIndicator description: Code indicating whether the service was related to family planning. Can be set to `Y` - Yes. source: healthcare type: string - name: FileType description: The file format. For example, `EDI/EDIFACT` for an EDIFACT file or `EDI/X12` for an X12 EDI file. source: core type: string - name: FollowInstructionsTask description: Follow-instructions task data containing text instructions for a user to follow. source: enrollment type: object - name: FormIdentification description: Use this object to attach standardized supplemental information to the claim when required by the payer. One example is payer documentation requirements for home health services. source: healthcare type: object - name: FormTypeCode description: Code indicating the type of form. Can be set to `AS` - Form Type Code or `UT` - Centers for Medicare and Medicaid Services (CMS) Durable Medical Equipment Regional Carrier (DMERC) Certificate of Medical Necessity (CMN) Forms. Set this to `AS` when you plan to include a home health form in the `formIdentifier` property. source: healthcare type: string - name: FrequencyCode description: Code indicating the frequency at which the rental equipment is billed. Can be set to `1` - weekly, `4` - monthly, or `6` - daily. source: healthcare type: string - name: GatewayTimeoutExceptionResponseContent description: The server was acting as a gateway or proxy and did not receive a timely response from the upstream server. source: core type: object - name: Gender description: Schema type from the Stedi healthcare API source: healthcare type: string - name: GenderWithUnknown description: Schema type from the Stedi healthcare API source: healthcare type: string - name: GenerateEdiRequestContent description: Schema type from the Stedi core API source: core type: object - name: GenerateEdiResponseContent description: Schema type from the Stedi core API source: core type: object - name: GenerateTransactionGroupEdiRequestContent description: Schema type from the Stedi core API source: core type: object - name: GenerateTransactionGroupEdiResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetElectronicRemittanceAdvicePdfOutputPayload description: 'A binary blob containing the Electronic Remittance Advice (ERA) PDF. You MUST send the ''accept: application/pdf'' header to get back the pdf content. Otherwise, the response will be base64-encoded and you must first decode it. To render the PDF, you must save the output to a file with a `.pdf` extension.' source: healthcare type: string - name: GetEnrollmentResponseContent description: Output containing the enrollment details. source: enrollment type: object - name: GetEventResponseContent description: Output containing the event details. source: event-destinations type: object - name: GetExecutionInputDocumentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetExecutionInputDocumentUrlResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetExecutionMetadataDocumentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetExecutionMetadataDocumentUrlResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetExecutionOutputDocumentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetExecutionOutputDocumentUrlResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetExecutionResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetInsuranceDiscoveryCheckResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: GetPDF1500OutputPayload description: A base64 encoded string of the CMS-1500 Claim Form PDF. To render the PDF, you must decode the base64 string and save it to a file with a `.pdf` extension. source: healthcare type: string - name: GetPayerRecordResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: GetProviderResponseContent description: Output containing the provider details. source: enrollment type: object - name: GetTransactionAttachmentDocumentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionAttachmentDocumentUrlResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionFragmentOutputDocumentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionFragmentOutputDocumentUrlResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionFragmentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionInputDocumentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionInputDocumentUrlResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionOutputDocumentResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionOutputDocumentUrlResponseContent description: Schema type from the Stedi core API source: core type: object - name: GetTransactionResponseContent description: Schema type from the Stedi core API source: core type: object - name: GovernmentServiceAffiliationCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: HealthCareCheckRemarkCodes description: Standard codes used to communicate informational remarks. source: healthcare type: object - name: HealthCareClaimStatusCategoryCode description: Code indicating the status category of the `statusCode` property. Visit [277CA code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#claim-status-category-code) for a complete list. source: healthcare type: string - name: HealthCareClaimStatusCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: HealthCareDiagnosisCode description: Information about the patient's healthcare diagnosis. source: healthcare type: object - name: HealthCareInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: HealthCarePolicyIdentification description: Included when the payer adjusted the payment in accordance with a published healthcare policy code list. source: healthcare type: object - name: HttpStatusCode description: A `200` response indicates that Stedi successfully generated the X12 EDI claim format required by the payer. It does not indicate whether the payer has accepted the claim - the payer will respond later with a 277CA containing this information. [Learn more about 277CAs](https://www.stedi.com/docs/healthcare/receive-claim-responses#response-types). A `400` response indicates one or more problems with the claim data in the request. Examples include missing required fields, invalid values, or incorrect data types. The response includes a message describing the problem. source: healthcare type: string - name: InPlanNetworkIndicatorCode description: "Code indicating whether the benefit is in-network or out-of-network.\ \ Can be `Y` - Yes, `N` - No, `U` - Unknown, or `W` - Not Applicable\n\n Code\ \ `U` indicates that it is unknown whether the benefits are in or out-of-network.\ \ Code `W` indicates that the benefit applies to both in and out-of-network providers.\ \ \n \n Note that this property **doesn't indicate** whether the provider is in\ \ or out-of-network for the patient. To determine that, you must check with the\ \ payer directly.\n\nPayers may sometimes return other non-compliant values." source: healthcare type: string - name: InPlanNetworkIndicatorName description: 'The name of the in-plan network indicator code. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: Index description: Schema type from the Stedi core API source: core type: object - name: IndividualRelationshipCode description: The dependent's relationship to the subscriber. You can set this to `01` - Spouse, `19` - Child, `34` - Other Adult. source: healthcare type: string - name: IndustryCode description: The type of facility where the service was provided. You can set this to one of the [place of service codes](https://www.cms.gov/medicare/coding-billing/place-of-service-codes/code-sets). source: healthcare type: string - name: InformationClaimStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InformationReceiverName description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InformationStatusCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: InitialEnrollmentStatus description: The enrollment's status when it is first created. You can create enrollments in either `DRAFT` or `STEDI_ACTION_REQUIRED` status. The default status is `DRAFT` if not specified. When you're ready for Stedi to begin processing the enrollment, set the status to `STEDI_ACTION_REQUIRED`. Once an enrollment is set to `STEDI_ACTION_REQUIRED`, only Stedi can set or update its status. source: enrollment type: string - name: InjuryCodeCategory description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: InstitutionalAddress description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalAdjustmentGroupCode description: Code identifying the general category of payment adjustment. Can be set to `CO` - Contractual Obligations, `CR` - Correction and Reversals, `OA` - Other adjustments, `PI` - Payor Initiated Reductions, or `PR` - Patient Responsibility. source: healthcare type: string - name: InstitutionalBilling description: 'Information about the billing provider. The following information is required: - An `address` that is a physical location such as the office where care is delivered or an administrative facility. - The provider''s Employer Identification Number (EIN) in `employerId`. - The provider''s business name in `organizationName`. - The provider''s [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier) in `npi`, if one is assigned. When the billing provider is not assigned an NPI, supply `secondaryIdentifier` with `secondaryIdentificationQualifierCode` set to `G2` (commercial number).' source: healthcare type: object - name: InstitutionalClaimAdjustment description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalClaimAdjustmentDetails description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalClaimDateInformation description: Dates and times related to the claim. For example, when the patient was discharged from the hospital. source: healthcare type: object - name: InstitutionalClaimEnrollmentProcess description: Details about the enrollment process for institutional claim submission. source: healthcare type: object - name: InstitutionalClaimFilingIndicatorCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: InstitutionalClaimIdentifier description: "A code specifying the type of transaction. Defaults to `CH` if not\ \ provided.\n - `31`: Only for use by state Medicaid agencies performing post\ \ payment recovery.\n - `CH`: Use when the transaction contains only fee for\ \ service claims or claims with at least one chargeable line item. Also use when\ \ it's not clear whether a transaction contains claims or capitated encounters,\ \ or if the transaction contains a mix of claims and capitated encounters.\n \ \ - `RP`: Use for capitated encounters. Also use when the transaction is being\ \ sent to an entity for purposes other than adjudication of a claim. For example,\ \ when you're sending the claim to a state health agency that is using the claim\ \ for health data reporting purposes." source: healthcare type: string - name: InstitutionalClaimInformation description: Information about the healthcare claim. Note that the objects and properties marked as required are required for all claims, while others are conditionally required, depending on type of claim and claim circumstances. For example, you must always provide the `claimChargeAmount`, but you only need to provide the `otherSubscriberInformation` object in coordination of benefits scenarios. When you include a conditionally required object, you must provide all of its required properties. source: healthcare type: object - name: InstitutionalClaimInformationBenefitsAssignmentCertificationIndicator description: Schema type from the Stedi healthcare API source: healthcare type: string - name: InstitutionalClaimReference description: Information about the claim. source: healthcare type: object - name: InstitutionalClaimSupplementalInformation description: Additional information or documentation required for the claim. This is where you can include information about [attachments](https://www.stedi.com/docs/healthcare/submit-claim-attachments), if applicable. source: healthcare type: object - name: InstitutionalClaimSupplementalInformationServiceLine description: Additional information or documentation required for the claim. This is where you can include information about [attachments](https://www.stedi.com/docs/healthcare/submit-claim-attachments), if applicable. source: healthcare type: object - name: InstitutionalClaimsExceptionCode description: Code specifying the exception reason for consideration of out-of-network health care services. Can be set to `1` - Non-Network Professional Provider in Network Hospital, `2` - Emergency Care, `3` - Services or Specialist not in Network, `4` - Out-of-Service Area, `5` - State Mandates, or `6` - Other. source: healthcare type: string - name: InstitutionalClaimsRawX12SubmissionRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalClaimsRawX12SubmissionResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalClaimsSubmissionRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalClaimsSubmissionResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalConditionInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalContactInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalDelayReasonCode description: Code indicating the reason for the delay in claim submission. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#delay-reason-codes) for a complete list. source: healthcare type: string - name: InstitutionalDependent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalDrugIdentification description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalError description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalIndividualRelationshipCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: InstitutionalLineAdjudicationInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalMeasurementUnit description: The unit of measurement for the service. Can be set to `DA` - Days or `UN` - Unit. source: healthcare type: string - name: InstitutionalMeasurementUnitCode description: Code identifying the unit of measure for the drug or biologic. Can be set to `F2` - International Unit, `GR` - Gram, `ME` - Milligram, `ML` - Milliliter, or `UN` - Unit. source: healthcare type: string - name: InstitutionalOtherInsuredIdentifierTypeCode description: Code identifying the type of identifier used for the other insured. Can be set to `II` - Standard Unique Health Identifier for each Individual in the United States or `MI` - Member Identification Number. Note that `II` is deprecated and should not be used in new claims. source: healthcare type: string - name: InstitutionalOtherInsuredQualifier description: Code identifying the type of entity. Can be set to `1` - Person or `2` - Non-Person Entity. source: healthcare type: string - name: InstitutionalOtherPayerBillingProvider description: Information regarding the other payer's billing provider. source: healthcare type: object - name: InstitutionalOtherPayerIdentifierTypeCode description: Code specifying the type of identifier used for the other payer. Can be set to `PI` - Payor Identification or `XV` - Centers for Medicare and Medicaid Services PlanID. Use `XV` when reporting Health Plan ID (HPID) or Other Entity Identifier (OEID). source: healthcare type: string - name: InstitutionalOtherPayerName description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalOtherPayerReferringProvider description: Information regarding the other payer's referring provider. This is the provider who sent the patient to another provider for services. source: healthcare type: object - name: InstitutionalOtherPayerRenderingProvider description: Information regarding the other payer's rendering provider. The rendering provider is the provider who performed the service or non-surgical procedure. source: healthcare type: object - name: InstitutionalOtherPayerServiceFacilityLocation description: Information regarding the other payer's service facility location. This is where the service was performed. source: healthcare type: object - name: InstitutionalOtherSubscriberInformation description: Required when other payers are known to potentially be involved in paying on this claim. This object contains information about other health plans under which the patient has coverage. It's used for coordination of benefits scenarios. source: healthcare type: object - name: InstitutionalOtherSubscriberInformationBenefitsAssignmentCertificationIndicator description: Schema type from the Stedi healthcare API source: healthcare type: string - name: InstitutionalOtherSubscriberInformationPaymentResponsibilityLevelCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: InstitutionalOtherSubscriberName description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalPayer description: Information about the payer for the submitted claim. source: healthcare type: object - name: InstitutionalProcedureIdentifier description: "Code identifying the type of `procedureCode`. If you set this property,\ \ you must also set `procedureCode`.\n\nCan be set to `ER` - Jurisdiction Specific\ \ Procedure and Supply Codes, `HC` - Health Care Financing Administration Common\ \ Procedural Coding System (HCPCS) Codes, `HP` - Health Insurance Prospective\ \ Payment System (HIPPS) Skilled Nursing Facility Rate Code, `IV` - Home Infusion\ \ EDI Coalition (HIEC) Product/Service Code, or `WK` - Advanced Billing Concepts\ \ (ABC) Codes. Note that ABC codes are deprecated and shouldn't be used in new\ \ claims. \n\nVisit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#product-or-service-id-qualifier-codes)\ \ for more information and usage instructions." source: healthcare type: string - name: InstitutionalProviderType description: Schema type from the Stedi healthcare API source: healthcare type: string - name: InstitutionalProvidersObject description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalReceiver description: The entity responsible for the payment of the claim, such as an insurance company or government agency. source: healthcare type: object - name: InstitutionalReferenceIdentification description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalReferring description: 'Information about the provider who referred the patient for care. - Include this object only when the referring provider is different than the provider listed in the `attending` object. - Use this object for providers that apply to the entire claim. - This should be an individual, not an organization, and you should supply at least the provider''s `lastName` and an identifier, which is typically the `npi`.' source: healthcare type: object - name: InstitutionalRelationshipToSubscriberCode description: Identifies the relationship of the patient to the subscriber. Can be set to `01` - Spouse, `19` - Child, `20` - Employee, `21` - Unknown, `39` - Organ Donor, `40` - Cadaver Donor, `53` - Life Partner, or `G8` - Other Relationship. source: healthcare type: string - name: InstitutionalRendering description: 'Information about the provider who delivered the medical services or non-surgical procedures listed in the claim. This must be an individual, not an organization, and you must supply at least the provider''s `lastName` and an identifier, which is typically the `npi`. The provider''s `firstName` is also required, if applicable. Include this object when all of the following are true: - The rendering provider is different than the provider listed in the `attending` object. - The provider applies to the entire claim or to at least one service line. For example, if a claim had two service lines with two different rendering providers, you would include the provider for the first service line here and leave the `claimInformation.serviceLines[].renderingProvider` object for that service line blank. Then, you would specify the second provider in the appropriate service line''s `claimInformation.serviceLines[].renderingProvider` object. - State or federal regulatory requirements call for a combined claim. A combined claim includes both facility and professional components, such as a Medicaid clinic bill or a critical access hospital claim.' source: healthcare type: object - name: InstitutionalReportInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalReportInformationAttachmentTransmissionCode description: Code identifying the method by which the provider's report is attached. Can be set to `AA` - Available on Request at Provider Site, `BM` - By Mail, `EL` - Electronically Only, `EM` - E-Mail, `FT` - File Transfer, or `FX` - By Fax. source: healthcare type: string - name: InstitutionalResponseMeta description: Metadata from Stedi about the request. source: healthcare type: object - name: InstitutionalService description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalServiceAuthorizationExceptionCode description: Code indicating the type of service authorization exception. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#service-authorization-exception-codes) for a complete list. source: healthcare type: string - name: InstitutionalServiceFacilityLocation description: 'The service facility location. Required when the location of healthcare services is different from the billing provider''s address. - When an organization''s healthcare provider''s [NPI](https://www.stedi.com/docs/healthcare/national-provider-identifier) is provided to identify the service location, the organization healthcare provider must be external to the entity identified as the billing provider (for example, a reference lab). - The service location can''t be a component or subpart of the billing provider entity. Only include this object when the service location is **different** from the billing provider''s address. If you include this object when the address is the same, Stedi omits all of the service facility location information from the claim submission, including the name and any identifiers. - Sometimes the billing provider is an actual physician group that is located at the same address as a hospital, but is in fact a separate entity. In this case, you can differentiate the service facility location by including the specific suite or building number of the physician group. This ensures that the service facility location is different from the billing provider''s address and is reported accurately.' source: healthcare type: object - name: InstitutionalServiceLine description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalServiceLineDateInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalServiceLineReferenceInformation description: Additional identifiers for the service line. We **strongly recommend** setting the `providerControlNumber` property for each service line within the claim. source: healthcare type: object - name: InstitutionalServiceLineReferringProvider description: 'Information about the provider who referred the patient for care. - Include this object only when the referring provider is different than the provider listed in the `attending` object. - This should be an individual, not an organization, and you should supply at least the provider''s `lastName` and an identifier, which is typically the `npi`.' source: healthcare type: object - name: InstitutionalServiceLineRenderingProvider description: "Information about the provider who delivered the medical services\ \ or non-surgical procedures in this service line. This must be an individual,\ \ not an organization, and you must include the provider's `lastName` and an identifier,\ \ which is typically the `npi`. The provider's `firstName` is also required, if\ \ applicable.\n\nInclude this object when the following are both true:\n -\ \ The rendering provider for this service line is different than the provider\ \ listed in the `attending` and `rendering` objects for the entire claim.\n \ \ - State or federal regulatory requirements call for a combined claim. A combined\ \ claim includes both facility and professional components, such as a Medicaid\ \ clinic bill or a critical access hospital claim." source: healthcare type: object - name: InstitutionalServiceLineSupplementalInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalSubmitter description: The entity submitting the healthcare claim. This is an organization, such as a hospital or other treatment center. source: healthcare type: object - name: InstitutionalSubmitterContactInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InstitutionalSubscriber description: 'The person or entity who is the primary policyholder for the health plan _or_ a dependent with their own member ID. - When a dependent has a unique, payer-assigned member ID, treat them as the subscriber for the claim submission - include their information here and omit the `dependent` object from the request. - You must set the `dateOfBirth` and `gender` properties when the subscriber is the patient. Stedi determines that the subscriber is the patient when the `dependent` object is not included in the request. - If either `dateOfBirth` or `gender` is set, you must include both properties. You can either include both properties or neither within a single request. - You must include `address` in this object when the patient is the subscriber. If the patient is a dependent, include address information in the `dependent` object instead.' source: healthcare type: object - name: InstitutionalSubscriberPaymentResponsibilityLevelCode description: The payer's level of responsibility for paying this claim. Can be set to `A` - Payer Responsibility Four, `B` - Payer Responsibility Five, `C` - Payer Responsibility Six, `D` - Payer Responsibility Seven, `E` - Payer Responsibility Eight, `F` - Payer Responsibility Nine, `G` - Payer Responsibility Ten, `H` - Payer Responsibility Eleven, `P` - Primary, `S` - Secondary, `T` Tertiary, or `U` - Unknown (only use in payer-to-payer COB claims). source: healthcare type: string - name: InsuranceDiscoveryCheckRequestContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InsuranceDiscoveryCheckResponseContent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InsuranceDiscoveryDependent description: 'Demographic information for the patient when they are a dependent on a health plan. - We **strongly recommend** providing as much information as possible to improve the probability of finding matching coverage. We especially recommend providing the dependent''s Social Security Number and their address - particularly their ZIP Code. - You should provide information for both the subscriber and the dependent in the request when possible. - If you only have the dependent''s information, you should identify them in the `subscriber` object instead and leave this object empty. Note that some payers require information about both the dependent and the subscriber, so providing only the dependent''s information limits Stedi''s ability to return coverage matches for those payers.' source: healthcare type: object - name: InsuranceDiscoveryEncounter description: "The date range for the service being requested. If you don't specify\ \ a service date (either a single day or a range of dates), Stedi defaults to\ \ the current date.\n\n You can specify either a single `dateOfService` or a `beginningDateOfService`\ \ and `endDateOfService`." source: healthcare type: object - name: InsuranceDiscoveryMetadata description: Metadata about the response. Stedi uses this data for tracking and troubleshooting. source: healthcare type: object - name: InsuranceDiscoveryProvider description: Information about the provider requesting the insurance discovery check. source: healthcare type: object - name: InsuranceDiscoveryResponseFields description: Schema type from the Stedi healthcare API source: healthcare type: object - name: InsuranceDiscoverySubscriber description: 'Demographic information for the patient when they are the health plan subscriber. We strongly recommend providing as much information as possible to improve the probability of finding matching coverage. We especially recommend providing the subscriber''s Social Security Number and their address - particularly their ZIP Code.' source: healthcare type: object - name: InsuranceTypeCode description: 'Code identifying the type of insurance policy. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: InsuranceTypeName description: 'The full name of the insurance type code. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: InterchangeMetadata description: Metadata for a single interchange within the EDI file. source: core type: object - name: InterchangeOverrides description: Schema type from the Stedi core API source: core type: object - name: InternalFailureExceptionResponseContent description: The server response when an unexpected error occurred while processing request. source: healthcare type: object - name: InvalidInterchangeEnvelopeException description: Returned when the X12 interchange envelope is rejected. This occurs when the `ISA-15` usage indicator does not match the API key's mode. source: claims type: object - name: LineAdjudicationInformation description: Includes service line adjudication information for coordination of benefits between the initial payers of a health care claim and all subsequent payers. source: healthcare type: object - name: LineAdjudicationInformationProductOrServiceIDQualifier description: Code identifying the type of `procedureCode`. Can be set to `ER` - Jurisdiction Specific Procedure and Supply Codes, `HC` - Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes, `HP` - Health Insurance Prospective Payment System (HIPPS) Skilled Nursing Facility Rate Code, `IV` - Home Infusion EDI Coalition (HIEC) Product/Service Code, or `WK` - Advanced Billing Concepts (ABC) Codes. Note that ABC codes are deprecated and shouldn't be used in new claims. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#product-or-service-id-qualifier-codes) for a complete list and usage guidelines. source: healthcare type: string - name: LineAdjudicationInformationServiceIdQualifier description: Code identifying the type of `procedureCode`. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#composite-medical-procedure-product-or-service-id-qualifier-codes) for a complete list. source: healthcare type: string - name: LineAdjustmentInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: LinePricingInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ListEnrollmentsResponseContent description: Output containing a paginated list of enrollments. source: enrollment type: object - name: ListEventsResponseContent description: Output containing the list of events. source: event-destinations type: object - name: ListExecutionFaultsResponseContent description: Common output structure for list operations with pagination support. source: core type: object - name: ListExecutionTransactionsResponseContent description: Common output structure for list operations with pagination support. source: core type: object - name: ListExecutionsResponseContent description: Common output structure for list operations with pagination support. source: core type: object - name: ListPayerRecordsCsvOutputPayload description: 'All supported payer records in CSV format. The first row contains the header with field names, and subsequent rows contain the payer data. To render this data as a CSV file, you must save it to a file with a `.csv` extension.' source: healthcare type: string - name: ListPayerRecordsResponseContent description: Common output structure for list operations with pagination support. source: healthcare type: object - name: ListPollingExecutionsResponseContent description: Common output structure for list operations with pagination support. source: core type: object - name: ListPollingTransactionsResponseContent description: Common output structure for list operations with pagination support. source: core type: object - name: ListProvidersResponseContent description: Output containing a paginated list of providers. source: enrollment type: object - name: ListTransactionsResponseContent description: Common output structure for list operations with pagination support. source: core type: object - name: MaintenanceReasonCode description: 'Code identifying the reason for the changes to subscriber identifying information, such as name, date of birth, or address. This is always `25` Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: MaintenanceTypeCode description: 'The maintenance type code. Used to acknowledge a change in the identifying elements for the subscriber from those submitted in the original eligibility check request. It can also be included when the payer used the birth sequence number from the original request to locate the subscriber in their system. This is always `001` Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: Mark description: The location in the document where the problem occurred. May be a single index or a range. source: core type: object - name: Matches description: 'Shows which properties in the payer record match the search query. This information helps you understand why Stedi returned this payer and which parts of the payer record matched the search terms. It''s also especially useful for debugging search queries and building user interfaces that display matching text. - Matching text is wrapped in `` HTML tags for highlighting. - This object only contains properties with matching text. For example, if none of the payer''s aliases matched the search query, this object will not include the `aliases` property.' source: healthcare type: object - name: MaximumResponseSizeExceeded description: Schema type from the Stedi healthcare API source: healthcare type: object - name: MdnFile description: The location of the Message Disposition Notification (MDN). This is only relevant for AS2 connections. source: core type: object - name: MeasurementQualifier description: Code identifying the specific measurement. Can be set to `HT` - Height, `R1` - Hemoglobin, `R2` - Hematocrit, `R3` - Epoetin Starting Dosage, or `R4` - Creatinine. source: healthcare type: string - name: MeasurementReferenceIdentificationCode description: Code identifying the type of measurement. Can be set to `OG` - Original or `TR` - Test Results. source: healthcare type: string - name: MeasurementUnit description: Code identifying the unit of measurement. Can be set to `MJ` - Minutes or `UN` - Unit. Minutes is required for anesthesia services. Note that anesthesia time is counted from the moment that the practitioner, having completed the preoperative evaluation, starts an intravenous line, places monitors, administers pre-anesthesia sedation, or otherwise physically begins to prepare the patient for anesthesia. Time continues throughout the case and while the practitioner accompanies the patient to the post-anesthesia recovery unit (PACU). Time stops when the practitioner releases the patient to the care of PACU personnel. source: healthcare type: string - name: MeasurementUnitCode description: Code identifying the unit of measurement. Can be set to `F2` - International Unit, `GR` - Gram, `ME` - Milligram, `ML` - Milliliter, or `UN` - Unit. source: healthcare type: string - name: Measurements description: Schema type from the Stedi healthcare API source: healthcare type: object - name: MedicalProcedure description: Schema type from the Stedi healthcare API source: healthcare type: object - name: MedicalProcedureProductOrServiceIDQualifier description: Code identifying the type/source of the `procedureCode`. You can set this to `AD` - American Dental Association Codes, `CJ` - Current Procedural Terminology (CPT) Codes, `HC` - Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes, `ID` - International Classification of Diseases, 9th Revision, Clinical Modification (ICD-9-CM) - Procedure, `IV` - Home Infusion EDI Coalition (HIEC) Product/Service Code, `N4` - National Drug Code in 5-4-2 Format, or `ZZ` - Mutually Defined. source: healthcare type: string - name: MedicareInpatientAdjudication description: Schema type from the Stedi healthcare API source: healthcare type: object - name: MedicareOutpatientAdjudication description: Claim-level data related to the adjudication of Medicare claims not related to an inpatient setting. Required when outpatient adjudication information is reported in the remittance advice _or_ when you need to report remark codes. source: healthcare type: object - name: Member description: Schema type from the Stedi healthcare API source: healthcare type: object - name: MemberGender description: A code indicating the dependent's gender. If the claim set the dependent's gender to `U` for unknown, you should omit this property from the claim status request. source: healthcare type: string - name: Meta description: Metadata that helps Stedi track and debug the response. source: healthcare type: object - name: Metadata description: Metadata about the generated EDI file. source: core type: object - name: MilitaryServiceRankCode description: Payers may sometimes return other non-compliant values. source: healthcare type: string - name: MissingParameter description: Returned when a required parameter is missing from the request. source: healthcare type: object - name: Mode description: Indicates whether the transaction contains test or production data. Stedi determines this from the value in [`ISA15` Usage Indicator Code](https://www.stedi.com/edi/x12/segment/ISA#ISA-15). source: core type: string - name: NoTransactionsFound description: Schema type from the Stedi healthcare API source: healthcare type: object - name: NotSupportedBreakdown description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OccurrenceInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OccurrenceSpanInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OperatingPhysician description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OperatingPhysicianIdentificationQualifierCode description: The type of identifier used in `secondaryIdentifier`. Can be set to `0B` - State License Number, `1G` - Provider UPIN Number, `G2` - Provider Commercial Number, or `LU` - Location Number. Note that UPIN is deprecated and should not be used. source: healthcare type: string - name: OperatingStateCode description: US state codes, territories, or `NATIONAL` indicating the geographic regions where a payer operates. When set to `NATIONAL`, the payer operates throughout the entire United States. source: healthcare type: string - name: Ordering description: Deprecated; please use `claimInformation.serviceLines[].orderingProvider` instead. source: healthcare type: object - name: OrthodonticTotalMonthsOfTreatment description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherDiagnosisInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherDiagnosisInformationPresentOnAdmissionIndicator description: Schema type from the Stedi healthcare API source: healthcare type: string - name: OtherDiagnosisInformationQualifierCode description: Code identifying the type of diagnosis code used. Can be set to `ABF` - International Classification of Diseases Clinical Modification (ICD-10-CM) or `BF` - International Classification of Diseases Clinical Modification (ICD-9-CM). Note that ICD-9 is deprecated and cannot be used in new claims. source: healthcare type: string - name: OtherInsuredIdentifierTypeCode description: Code identifying the type of identifier. Can be set to `II` - Standard Unique Health Identifier for each individual in the United States or `MI` - Member Identification Number. The code `MI` should be the subscriber's identification number as assigned by the payer, such as their subscriber ID. You should also use `MI` in claims submitted to the Indian Health Service/Contract Health Services (IHS/CHS) Fiscal Intermediary for the purpose of reporting the Tribe Residency Code (Tribe County State). For IHS/CHS claims, you should also put the SSN in the `otherInsuredAdditionalIdentifier` property.) source: healthcare type: string - name: OtherInsuredQualifier description: Code identifying the type of entity. Can be set to `1` - Person or `2` - Non-Person Entity. source: healthcare type: string - name: OtherPayerAssistantSurgeon description: Information about the assistant surgeon. source: healthcare type: object - name: OtherPayerAssistantSurgeonIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherPayerAttendingProvider description: Information regarding the other payer's attending provider. The attending provider is the provider who is primarily responsible for the care of the patient. source: healthcare type: object - name: OtherPayerBillingProvider description: Information about the billing provider. source: healthcare type: object - name: OtherPayerBillingProviderEntityTypeQualifier description: Code identifying the type of entity. Can be set to `1` - Person or `2` - Non-Person Entity. source: healthcare type: string - name: OtherPayerBillingProviderIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherPayerEntityTypeQualifier description: Schema type from the Stedi healthcare API source: healthcare type: string - name: OtherPayerIdentifierTypeCode description: Code designating the type of identifier. Can be set to `PI` - Payor Identification or `XV` - Centers for Medicare/Medicaid Services PlanID. Use code value `XV` when reporting Health Plan ID (HPID) or Other Entity Identifier (OEID). source: healthcare type: string - name: OtherPayerName description: Details about the other payer. source: healthcare type: object - name: OtherPayerOperatingPhysician description: Information regarding the other payer's operating physician. The operating physician is the provider who performed the procedure. source: healthcare type: object - name: OtherPayerOtherOperatingPhysician description: Information regarding the other payer's other operating physician. The other operating physician is the provider who performed a secondary surgical procedure or assisted the `otherPayerOperatingPhysician`. source: healthcare type: object - name: OtherPayerReferringProvider description: Information about the provider who directed the patient to the rendering provider for care. For example, a primary care physician may refer patients to a specialist. source: healthcare type: object - name: OtherPayerReferringProviderIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherPayerRenderingProvider description: Information about the rendering provider. source: healthcare type: object - name: OtherPayerRenderingProviderEntityTypeQualifier description: Code identifying the type of entity. Can be set to `1` - Person or `2` - Non-Person Entity. source: healthcare type: string - name: OtherPayerRenderingProviderIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherPayerSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherPayerServiceFacilityLocation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherPayerServiceFacilityLocationSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherPayerSupervisingProvider description: Information about the supervising provider. source: healthcare type: object - name: OtherPayerSupervisingProviderIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherProcedureInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherProcedureInformationQualifierCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: OtherSubscriber description: Information about the other subscriber, when a corrected priority payer has been identified. source: healthcare type: object - name: OtherSubscriberInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: OtherSubscriberInformationBenefitsAssignmentCertificationIndicator description: Code indicating whether or not the insured has authorized the plan to remit payment directly to the provider. Can be set to `N` - No (Payment should go to the patient), `Y` - Yes (Payment should go directly to the provider), or `W` - Not Applicable. source: healthcare type: string - name: OtherSubscriberInformationInsuranceTypeCode description: Code identifying the type of insurance policy within a specific insurance program. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#insurance-type-codes) for a complete list. source: healthcare type: string - name: OtherSubscriberInformationPaymentResponsibilityLevelCode description: 'Code identifying the payer''s level of responsibility for paying this claim. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#payment-responsibility-sequence-number-codes) for a complete list. - Either this property or `subscriber.paymentResponsibilityLevelCode` must be set to `P` to indicate the primary insurance payer. Stedi rejects claims - including secondary and tertiary claims - that don''t include information for the primary payer. - You may need to use other codes if the patient has multiple insurance policies. For example, if a patient is covered by both Medicare and an employer-sponsored commercial plan, you could bill the commercial payer first as `P` and then bill the Medicare payer second as `S`.' source: healthcare type: string - name: OtherSubscriberName description: The person or entity who is the primary policyholder for the other payer's health plan. source: healthcare type: object - name: PDFData description: Schema type from the Stedi healthcare API source: healthcare type: object - name: PDFError description: Schema type from the Stedi healthcare API source: healthcare type: object - name: Partnership description: 'Information about the associated partnership. A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files. If you''re sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnership for you automatically when you set up your account.' source: core type: object - name: PartnershipReceiver description: The entity that is receiving the transaction. source: core type: object - name: PartnershipSender description: The entity that initiated the transaction. source: core type: object - name: PartnershipType description: The type of partnership, which determines the EDI standard used for exchanging transactions. source: core type: string - name: PatientClaimStatusDetails description: Patient information and the status of claims related to the patient. You can use the `claims[].claimStatus.referencedTransactionTraceNumber` in this object to correlate the 277CA with the original claim. source: healthcare type: object - name: PatientClaimStatusDetailsDependent description: Information about a dependent who received services related to the claim. source: healthcare type: object - name: PatientClaimStatusDetailsSubscriber description: Information about the primary policy holder for the health plan. source: healthcare type: object - name: PatientConditionCode description: A code indicating the nature of a patient's condition. source: healthcare type: string - name: PatientConditionInformationVision description: Required on vision claims involving replacement lenses or frames when this information is known to impact reimbursement. . source: healthcare type: object - name: PatientConditionInformationVisionCertificationConditionIndicator description: Code indicating whether there is a certification. Can be set to `N` - No or `Y` - Yes. source: healthcare type: string - name: PatientConditionInformationVisionConditionCodesItem description: Code indicating the reason for the vision services. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#vision-condition-codes) for a complete list. source: healthcare type: string - name: PatientReasonForVisit description: Schema type from the Stedi healthcare API source: healthcare type: object - name: PatientReasonForVisitQualifierCode description: Code identifying the type of reason for visit code used. Can be set to `APR` - International Classification of Diseases Clinical Modification Patient's Reason for Visit or `PR` - International Classification of Diseases Clinical Modification Patient's Reason for Visit. Note that ICD-9 is deprecated and cannot be used in new claims. source: healthcare type: string - name: PayToAddressName description: Use to specify an address for payment that is different from the billing provider's physical address. This is relevant when the provider expects to receive paper checks at a different location, such as a PO Box, lockbox, or other mailing address. source: healthcare type: object - name: PayToAddressNameEntityTypeQualifier description: Code identifying the type of entity. Can be set to `2` - Non-Person Entity. source: healthcare type: string - name: PayToPlan description: Use for subrogation payment requests. If you include this information, you must also set the `claimInformation.otherSubscriberInformation.payerPaidAmount` to the amount the payer (for example, Medicaid) actually paid. source: healthcare type: object - name: PayToPlanName description: Use for subrogation payment requests. If you include this information, you must also set the `claimInformation.otherSubscriberInformation.payerPaidAmount` to the amount the payer (for example, Medicaid) actually paid. source: healthcare type: object - name: PayToPlanNameIdentificationCodeQualifier description: The type of identification code used to identify the organization. Can be set to `PI` - Payer Identification or `XV` - Centers for Medicare and Medicaid Services PlanID. Use `XV` when reporting the Health Plan ID (HPID) or Other Entity Identifier (OEID). source: healthcare type: string - name: Payee description: Information about the provider receiving the payment. source: healthcare type: object - name: PayeeAddress description: Address information for the payee. source: healthcare type: object - name: PayeeRemittanceDeliveryMethod description: The method by which the remittance advice is delivered. This is used when the remittance is separate from the payment. source: healthcare type: object - name: Payer description: Information about the payer providing the benefits information. The response will always include the payer's business name and an identifier, such as the payer's tax ID. Most payers also include contact information. source: healthcare type: object - name: PayerContactInformation description: The payer's business contact information. source: healthcare type: object - name: PayerEntityIdentifier description: 'The entity identifier code for the payer. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: PayerEntityIdentifierCode description: Entity identifier code for payers in claim status reports source: healthcare type: string - name: PayerEntityIdentifierCodeValue description: Human-readable descriptions for payer entity identifier codes source: healthcare type: string - name: PayerRecord description: Schema type from the Stedi healthcare API source: healthcare type: object - name: PayerUrls description: URLs associated with a payer. source: healthcare type: object - name: PaymentFormatCode description: Identifies the specific electronic payment format used for ACH transactions. These formats determine the structure and content of the electronic payment message. source: healthcare type: string - name: PaymentInfo description: Detailed payment information for a specific claim. source: healthcare type: object - name: PaymentInfoClaimPaymentInfo description: Claim payment information for the payment info structure. source: healthcare type: object - name: PaymentInfoClaimSupplementalInformation description: Additional information about the claim payment. All values are expressed as decimals. source: healthcare type: object - name: PaymentInfoClaimSupplementalInformationQuantities description: Additional quantity information about the claim payment. All values are expressed as decimals. source: healthcare type: object - name: PaymentInfoCorrectedPatientOrInsuredName description: Used to provide corrected information about the insured. source: healthcare type: object - name: PaymentInfoInpatientAdjudication description: Information about the adjudication of inpatient claims. source: healthcare type: object - name: PaymentInfoOtherClaimRelatedIdentification description: Additional reference numbers to identify the specific claim. source: healthcare type: object - name: PaymentInfoOutpatientAdjudication description: Information about the adjudication of claims not related to an inpatient setting. source: healthcare type: object - name: PaymentInfoPatientName description: Information about the individual who received medical services. source: healthcare type: object - name: PaymentInfoRenderingProvider description: Information about the provider who rendered the services. source: healthcare type: object - name: PaymentInfoRenderingProviderIdentification description: Additional identifiers for the rendering provider. source: healthcare type: object - name: PaymentInfoSubscriber description: Information about the primary policyholder for the health plan. This may or may not be the patient. source: healthcare type: object - name: PaymentMethodCode description: Specifies the method used to deliver payment to the provider. This determines how the payment will be transmitted, such as electronically through ACH, by physical check, or wire transfer. source: healthcare type: string - name: PdfUploadResponse description: Response data containing the uploaded PDF after completion. source: enrollment type: object - name: PlaceOfServiceCode description: Code identifying the type of facility where the services were or may be performed. source: healthcare type: string - name: PlanDateInformation description: 'Contains the dates associated with the subscriber and dependents'' (if applicable) insurance plan. This information is used to determine their eligibility for benefits. - Most fields contain a single date, but some can contain either a single date or a date range. Each field''s documentation specifies its format. - Fields that can contain either a single date or date range include: `plan`, `eligibility`, `planBegin`, `admission`, and `service`. - The provided dates apply to every benefit within the patient''s health plan unless specifically noted within a `benefitsInformation[].benefitsDateInformation` object. - If the payer sends back date(s) that are different for the subscriber and dependents, Stedi includes only the dates for the dependent in this object and omits the subscriber''s date(s). Dependents can have different coverage dates than the subscriber due to qualifying life events, such as starting a new job or passing the age limit for coverage through their parent''s plan. - Most payers return either `plan` or `planBegin` and `planEnd`, but the exact dates returned depend on the payer''s discretion and the patient''s insurance plan. - If the date of service is after the earliest ending `plan`, `eligibility`, `planEnd`, `eligibilityEnd`, `policyEffective`, or `policyExpiration` value, the patient likely doesn''t have active coverage.' source: healthcare type: object - name: PlanInformation description: Additional identification for the subscriber's healthcare plan. source: healthcare type: object - name: PlanParticipationCode description: Code indicating whether the provider accepts assignment. This refers to whether the provider accepts assignment and/or has a participation agreement with the destination payer. It does not indicate whether the patient has assigned benefits to the provider. Can be set to `A` - Assigned, `B` - Assignment Accepted on Clinical Lab Services Only, or `C` - Not Assigned. Choose `A` when the provider accepts assignment and/or has a participation agreement with the destination payer, OR the provider does not accept assignment and/or have a participation agreement, but is advising the payer to adjudicate this specific claim under the participating provider benefits allowed under certain plans. source: healthcare type: string - name: PlanStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: PolicyComplianceCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: PredeterminationOfBenefits description: Schema type from the Stedi healthcare API source: healthcare type: object - name: PregnancyIndicator description: Code indicating whether the patient is pregnant. Can be set to `Y` - Yes. source: healthcare type: string - name: PricingMethodologyCode description: Code indicating the pricing or repricing methodology. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#pricing-methodology-codes-2) for a complete list. source: healthcare type: string - name: PrimaryIdentifierTypeCode description: Code identifying the type of identifier. Can be set to `PI` - Payor Identification or `XV` - Centers for Medicare/Medicaid Services PlanID. Use code value `XV` when reporting Health Plan ID (HPID) or Other Entity Identifier (OEID). source: healthcare type: string - name: PrincipalDiagnosis description: Schema type from the Stedi healthcare API source: healthcare type: object - name: PrincipalDiagnosisPresentOnAdmissionIndicator description: Indicates whether the principal diagnosis was present on admission. Can be set to `N` - No (onset did NOT occur prior to admission to the hospital), `Y` - Yes (onset occurred prior to admission to the hospital), `U` - Unknown, or `W` - Not Applicable. source: healthcare type: string - name: PrincipalDiagnosisQualifierCode description: Code identifying the type of diagnosis code used. Can be set to `ABK` - International Classification of Diseases Clinical Modification Principal Diagnosis or `BK` - International Classification of Diseases Clinical Modification (ICD-9-CM) Principal Diagnosis. Note that ICD-9 is deprecated and cannot be used in new claims. source: healthcare type: string - name: PrincipalProcedureInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: PrincipalProcedureInformationQualifierCode description: Code identifying the type of procedure code used. Can be set to `BBR` - International Classification of Diseases Clinical Modification (ICD-10-PCS) Principal Procedure Codes, `BR` - International Classification of Diseases Clinical Modification (ICD-9-CM) Principal Procedure Codes, or `CAH` - Advanced Billing Concepts (ABC) Codes. Note that ICD-9 and ABC codes are deprecated and cannot be used in new claims. source: healthcare type: string - name: PriorAuthorization description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ProcedureIdentifier description: Code identifying the specific industry code list used for the `procedureCode`. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#composite-medical-procedure-product-or-service-id-qualifier-codes) for a complete list. source: healthcare type: string - name: ProductOrServiceIDQualifier description: A code identifying the type/source of the descriptive number used in Product/Service ID. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#product-or-service-id-qualifier) for a complete list. source: healthcare type: string - name: ProductServiceIdQualifier description: Identifies the coding system or classification used to describe medical products, services, or procedures. These qualifiers specify which standardized code set is being used to identify the healthcare service or product. source: healthcare type: string - name: ProfessionalClaimEnrollmentProcess description: Details about the enrollment process for professional claim submission. source: healthcare type: object - name: ProfessionalService description: Information about the service rendered. source: healthcare type: object - name: ProfileType description: Schema type from the Stedi core API source: core type: string - name: ProsthesisCrownOrInlayCode description: Code indicating the placement status for the dental work. Can be set to `I` - Initial Placement or `R` - Replacement. When set to `R`, you must include either the `priorPlacementDate` or `estimatedPriorPlacementDate` properties within the `claimInformation.serviceLines[].serviceLineDateInformation` object. source: healthcare type: string - name: ProvideFilledPdfTask description: A task that requires uploading a PDF document. Stedi will either provide an enrollment template PDF to download and complete, or provide instructions for uploading supporting documentation, such as a W-9 form. source: enrollment type: object - name: ProvideInformationResponse description: Response data for `ProvideInformation` task completion. source: enrollment type: object - name: ProvideInformationTask description: Task for collecting specific information from the provider. source: enrollment type: object - name: Provider description: "Information about the entity requesting the eligibility check. This\ \ may be an individual practitioner, a medical group, a hospital, or another type\ \ of healthcare provider.\n - You must provide the `organizationName` (if the\ \ entity is an organization), or `firstName` and `lastName` (if the provider is\ \ an individual).\n - You must also provide an identifier - this is typically\ \ the provider's [National Provider Identifier](https://www.stedi.com/docs/healthcare/national-provider-identifier)\ \ (`npi`). If the provider doesn't have an NPI, you can supply an alternative,\ \ such as their `taxId` or `ssn`.\n - Don't include additional properties, such\ \ as `taxId` or `address`, unless they are specifically required or suggested\ \ by the payer." source: healthcare type: object - name: ProviderAdjustments description: Provider-level adjustments unrelated to specific claims. source: healthcare type: object - name: ProviderClaimStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ProviderContact description: "The contact information for the provider. These contacts appear as\ \ prepopulated options for contact information when creating enrollment requests\ \ for this provider in the Stedi portal. They aren't automatically added to enrollment\ \ requests.\n\nThese contacts should specify where payers should send communications\ \ about the enrollment, if needed.\n - Either `organizationName` _or_ `firstName`\ \ and `lastName` are required.\n - The name and address should match exactly\ \ what the payer has on file for the provider. Some payers reject enrollment requests\ \ with addresses that don't match their records.\n - If you're submitting enrollment\ \ requests on a provider's behalf, you may want to set the phone number and email\ \ to your own contact details. Do this when you want the payer to contact you\ \ about the enrollment status instead of the provider directly.\n - These contacts\ \ are for convenience only. You can specify different contacts on enrollment requests\ \ as needed." source: enrollment type: object - name: ProviderEntityIdentifierCode description: Entity identifier code for providers in claim status reports source: healthcare type: string - name: ProviderEntityIdentifierCodeValue description: Human-readable descriptions for provider entity identifier codes source: healthcare type: string - name: ProviderInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ProviderStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ProviderSummary description: Summary information for a provider, typically used in list operations. source: enrollment type: object - name: ProviderSummaryInformation description: Summary information about the provider, including the provider's identifier, where the services were performed, and total claim charge amounts. source: healthcare type: object - name: ProviderSupplementalSummaryInformation description: Additional summary information about the provider and the charges in the claim. All values are expressed as decimals. source: healthcare type: object - name: ProviderType description: Identify the type of provider. source: healthcare type: string - name: PurchasedServiceInformation description: Specify information about services that were purchased. Required on non-vision service lines when adjudication is known to be impacted by the charge amount for services purchased from another source OR when adjudication is known to be impacted by the acquisition cost of lenses. source: healthcare type: object - name: QuantityQualifierCode description: 'Code indicating the type of quantity for the benefit. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: QuantityQualifierName description: 'The name of the quantity qualifier code. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: QuestionResponseCode description: Code indicating a yes or no condition response to the question. Can be set to `N` - No, `W` - Not Applicable, or `Y` - Yes. source: healthcare type: string - name: QuotaExceededExceptionResponseContent description: The server response for the usage plan quota exceeded error. source: enrollment type: object - name: RawEligibilityResponseValidationErrors description: Schema type from the Stedi healthcare API source: healthcare type: object - name: Receiver description: The entity responsible for the payment of the claim, such as an insurance company or government agency. source: healthcare type: object - name: ReceiverAccountDetails description: Financial institution account details for the payment receiver. source: healthcare type: object - name: Referring description: 'Information about the provider who directed the patient to the rendering provider for care. For example, a primary care physician may refer patients to a specialist. Use when the referring provider applies to the entire claim, not just a specific service line. This should be an individual, not an organization, and you should supply at least the provider''s `lastName` and an identifier, which is typically the `npi`.' source: healthcare type: object - name: ReferringProviderType description: Defines the referring provider type. source: healthcare type: string - name: ReferringSecondaryIdentificationQualifierCode description: The type of identifier used in `secondaryIdentifier`. Can be set to `0B` - State License Number, `1G` - Provider UPIN Number, or `G2` - Provider Commercial Number. Note that UPIN is deprecated and should not be used. source: healthcare type: string - name: RejectReasonCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: RelatedEntityIdentifierName description: "Code identifying an organizational entity, a physical location, property\ \ or an individual. \n - `PPO` is used to identify a PPO by name or identification\ \ number, and also may also be used if identifying the Network that benefits are\ \ restricted to for In-Network benefits.\n\nPayers may sometimes return other\ \ non-compliant values." source: healthcare type: string - name: RelationToSubscriberCode description: The code indicating the dependent's relationship to the subscriber. source: healthcare type: string - name: RelationToSubscriberCodeName description: The name of the `relationToSubscriberCode`. source: healthcare type: string - name: RelationshipToSubscriberCode description: Identifies the relationship of the patient to the subscriber. Can be set to `01` - Spouse, `19` - Child, `20` - Employee, `21` - Unknown, `39` - Organ Donor, `40` - Cadaver Donor, `53` - Life Partner, or `G8` - Other Relationship. source: healthcare type: string - name: ReleaseInformationCode description: Indicates whether the provider has on file a signed statement by the patient authorizing the release of medical data to other organizations. Can be set to `Y` - Yes, or `I` - Informed Consent to Release Medical Information for Conditions or Diagnoses Regulated by Federal Statues. Use `I` when the provider has not collected a signature AND state or federal laws do not require a signature be collected. source: healthcare type: string - name: ReleaseOfInformationCode description: Code indicating whether the provider has on file a signed statement by the patient authorizing the release of medical data to other organizations. Can be set to `I` - Informed Consent to Release Medical Information or `Y` - Yes. Code `I` is required when the provider has not collected a signature AND state or federal laws do not require a signature be collected. Code `Y` is required when the provider has collected a signature OR when state or federal laws require a signature be collected. source: healthcare type: string - name: Rendering description: 'Information about the person or company (laboratory or other facility) who rendered the care. Use this object for all types of rendering providers including laboratories. When a substitute provider (locum tenens) was used, enter that provider''s information here. - Use when the provider applies to the entire claim or to at least one service line. For example, if a claim had two service lines with two different rendering providers, you would include the provider for the first service line here and leave the `claimInformation.serviceLines[].renderingProvider` object for that service line blank. Then, you would specify the second provider in the appropriate service line''s `claimInformation.serviceLines[].renderingProvider` object. - You can omit this object when the rendering provider is the same as the billing provider. In that case, you would include the provider''s information in the `billing` object and leave this object blank.' source: healthcare type: object - name: RenderingProviderType description: Defines the rendering provider type. source: healthcare type: string - name: RenderingSecondaryIdentificationQualifierCode description: The type of identifier used in `secondaryIdentifier`. Can be set to `0B` - State License Number, `1G` - Provider UPIN Number, `G2` - Provider Commercial Number, or `LU` - Location Number. Note that UPIN is deprecated and should not be used. source: healthcare type: string - name: RepairOptions description: Options for repairing EDI data during generation to ensure it meets X12 requirements source: core type: object - name: ReportInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ReportInformationAttachmentReportTypeCode description: Code indicating the title or contents of a document, report or supporting item. For example, `08` - Plan of Treatment or `CT` - Certification. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#attachment-report-type-codes) for a complete list. source: healthcare type: string - name: ReportInformationAttachmentTransmissionCode description: 'Code identifying the method by which the provider''s report is attached. Can be set to `AA` - Available on Request at Provider Site, `BM` - By Mail, `EL` - Electronically Only, `EM` - E-Mail, `FT` - File Transfer, or `FX` - By Fax. Set this to `EL` when you plan to submit attachments electronically through Stedi APIs.' source: healthcare type: string - name: ReportsClaimAcknowledgmentResponse description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ReportsClaims description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ReportsContactInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: RepricedApprovedServiceUnitCode description: The approved service units or inpatient days. Can be set to `DA` - Days or `UN` - Unit. source: healthcare type: string - name: RequestChangedExceptionResponseContent description: Exception returned when a request uses an idempotency key that was previously used with different request parameters. source: healthcare type: object - name: RequestDependent description: Schema type from the Stedi healthcare API source: healthcare type: object - name: RequestDependentAddress description: Address information for the dependent. When providing address information, we recommend including `state` for member identification in addition to the required `address1` and `city` properties. source: healthcare type: object - name: RequestDependentProviderCode description: "Use this for providers that are not requesting the eligibility check\ \ - the requestor is specified in the `provider` object. For example, if you are\ \ a hospital making an eligibility request, this is where you would specify information\ \ about a referring provider's role. \n\n You can use one of the following: `AD`\ \ - Admitting, `AT` - Attending, `BI` - Billing, `CO` - Consulting, `CV` - Covering,\ \ `H` - Hospital, `HH` - Home Health Care, `LA` - Laboratory, `OT` - Other Physician,\ \ `P1` - Pharmacist, `P2` - Pharmacy, `PC` - Primary Care Physician, `PE`- Performing,\ \ `R`- Rural Health Clinic, `RF` - Referring, `SB` - Submitting, `SK` - Skilled\ \ Nursing Facility, `SU` - Supervising" source: healthcare type: string - name: RequestDependentReferenceIdentificationQualifier description: "The type of `providerIdentifier` you are using. Use for providers\ \ that are not requesting the eligibility check, such as the referring provider.\n\ - Set to `HPI` when the National Provider ID is mandated for use.\n- Set to `PXC`\ \ if you're identifying a type of specialty associated with services provided\ \ to the dependent. \n \n Otherwise, you can set to the following: `9K` - Servicer,\ \ `D3` - National Council for Prescription Drug Programs Pharmacy Number, `EI`\ \ - Employer's Identification Number, `HPI` - Centers for Medicare and Medicaid\ \ Services National Provider Identifier, `PXC` - Health Care Provider Taxonomy\ \ Code, `SY` - Social Security Number, `TJ` - Federal Taxpayer's Identification\ \ Number" source: healthcare type: string - name: RequestEligibilityServiceTypeCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: RequestProviderAddress description: "Address information for the provider.\n - Only include when specifically\ \ instructed by a payer, such as when the provider has multiple locations and\ \ you need to identify the specific location making the request.\n - You must\ \ include at least the `address1` and `city` properties." source: healthcare type: object - name: RequestProviderCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: RequestStateOrProvinceCode description: The US state or Canadian province code. For example, `TN` for Tennessee or `NB` for New Brunswick. source: healthcare type: string - name: RequestSubscriber description: 'The primary policyholder for the insurance plan _or_ a dependent with a unique member ID. If a dependent has a unique member ID, include their information here and leave `dependents` empty. - At a minimum, our API requires that you supply at least one of these fields in the request: `memberId`, `dateOfBirth`, or `lastName`. However, each payer has different requirements, so you should supply the fields necessary for each payer to identify the subscriber in their system. - When you provide all four of `memberId`, `dateOfBirth`, `firstName`, and `lastName`, payers are required to return a response if the member is in their database. Some payers may be able to search with less information, but this varies by payer. - We recommend always including the patient''s member ID when possible. - Enter the patient''s name exactly as written on their insurance card, if available, including any special or punctuation characters such as apostrophes, hyphens (dashes), or spaces. Visit [patient names](https://www.stedi.com/docs/healthcare/send-eligibility-checks#patient-names) for all best practices to avoid unnecessary failures.' source: healthcare type: object - name: RequestSubscriberAddress description: "Address information for the subscriber. When providing address information:\n\ \ - The `address1` and `city` properties are **required** for standard eligibility\ \ checks and MBI lookups with SSN. We also recommend including `state` for member\ \ identification.\n - When performing an [MBI lookup without SSN](https://www.stedi.com/docs/healthcare/mbi-lookup)\ \ (Payer ID: `MBILUNOSSN`), only `state` is required. You can omit `address1`\ \ and `city`." source: healthcare type: object - name: RequestSubscriberDependentAddress description: 'The patient''s address. Every claim must include this information in either the `subscriber` (when the patient is the subscriber) or `dependent` (when the patient is a dependent) object. You must include at least the `address1` and `city` properties in this object. The `state` and `postalCode` properties are also required for all United States and Canadian addresses. - The address must be the patient''s correct address at the time of service. Don''t use placeholder values to complete unknown address information. Use of outdated or placeholder values could cause the payer to reject, deny, or delay the claim due to suspected fraud. - If you don''t know the patient''s address, you should first submit a [Real-Time Eligibility Check](https://www.stedi.com/docs/healthcare/api-reference/post-healthcare-eligibility) for the patient and then copy the patient''s address from either the `subscriber` or `dependent` object in the response. - If the patient doesn''t have a current address, you can populate the `address1` property with `UNKNOWN` and populate the city, state, and zip code with appropriate values based on your discretion. However, some payers may have explicit rules for how to handle this situation, so you should check the payer''s specific requirements before using this approach.' source: healthcare type: object - name: RequestSubscriberProviderCode description: "Use this for providers that are not requesting the eligibility check\ \ - the requestor is specified in the `provider` object. For example, if you are\ \ a hospital making an eligibility request, this is where you would specify information\ \ about a referring provider's role. \n\n This property is **required** when the\ \ `providerIdentifier` and `referenceIdentificationQualifier` properties are populated.\ \ \n\n You can use one of the following: `AD` - Admitting, `AT` - Attending, `BI`\ \ - Billing, `CO` - Consulting, `CV` - Covering, `H` - Hospital, `HH` - Home Health\ \ Care, `LA` - Laboratory, `OT` - Other Physician, `P1` - Pharmacist, `P2` - Pharmacy,\ \ `PC` - Primary Care Physician, `PE` - Performing, `R` - Rural Health Clinic,\ \ `RF` - Referring, `SB` - Submitting, `SK` - Skilled Nursing Facility, `SU` -\ \ Supervising" source: healthcare type: string - name: RequestSubscriberReferenceIdentificationQualifier description: "Use this for providers that are not requesting the eligibility check.\ \ This is the type of `providerIdentifier` you are providing.\n- Set to `HPI`\ \ when the National Provider ID is mandated for use.\n- Set to `PXC` if you're\ \ identifying a type of specialty associated with services provided to the subscriber.\ \ \n \n Otherwise, you can set to the following: `9K` - Servicer, `D3` - National\ \ Council for Prescription Drug Programs Pharmacy Number, `EI` - Employer's Identification\ \ Number, `HPI` - Centers for Medicare and Medicaid Services National Provider\ \ Identifier, `PXC` - Health Care Provider Taxonomy Code, `SY - Social Security\ \ Number, `TJ` - Federal Taxpayer's Identification Number" source: healthcare type: string - name: RequestedEffectiveDate description: Whether a payer supports specifying a requested effective date for transaction enrollments. source: healthcare type: string - name: ResourceNotFoundException description: The server response when the specified resource cannot be found after an API request passes authentication and authorization. source: healthcare type: object - name: ResourceNotFoundExceptionResponseContent description: The server response when the specified resource cannot be found after an API request passes authentication and authorization. source: core type: object - name: ResourceUnderChangeExceptionResponseContent description: Schema type from the Stedi core API source: core type: object - name: ResponseDependent description: Information about the dependent listed in the original eligibility check request. Note that a dependent submitted in the request may be returned in the subscriber object. When present, this object will always include the dependent's name for identification, but many payers will also return the date of birth and other identifying information. source: healthcare type: object - name: ResponseDependentEntityIdentifier description: The entity identifier for the dependent. source: healthcare type: string - name: ResponseEligibilityServiceType description: 'The name of a Service Type Code listed in the `serviceTypeCodes` array. Visit [Service Type Codes](https://www.stedi.com/docs/healthcare/send-eligibility-checks#service-type-codes) for a complete list of codes and their names. The word physician in service type codes refers to any healthcare provider, including physician assistants, nurse practitioners, and other types of healthcare professionals. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: ResponseEligibilityServiceTypeCode description: 'A code identifying a type of service. Visit [Service Type Codes](https://www.stedi.com/docs/healthcare/send-eligibility-checks#service-type-codes) for a complete list. This list is specific to X12 version 005010, which is the mandated version for eligibility checks. It differs from the current [X12 Service Type Codes](https://x12.org/codes/service-type-codes) list, which applies to X12 versions later than 005010. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: ResponseMeta description: Metadata from Stedi about the request. source: healthcare type: object - name: ResponseProvider description: Information about the entity that submitted the original eligibility check request. This may be an individual practitioner, a medical group, a hospital, or another type of healthcare provider. This object will always include at least one identifier, such as the provider's [NPI](https://www.stedi.com/docs/healthcare/national-provider-identifier), tax ID, or EIN. source: healthcare type: object - name: ResponseProviderCode description: 'A code indicating the type of provider. Visit [Eligibility code lists](https://www.stedi.com/docs/healthcare/eligibility-code-lists#provider-codes) for a complete list. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: ResponseProviderEntityIdentifier description: 'A code identifying the type of provider. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: ResponseStateOrProvinceCode description: 'The US state or Canadian province code with unknown option. For example, `TN` for Tennessee or `NB` for New Brunswick. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: ResponseSubscriber description: Information about the primary policyholder for the insurance plan listed in the original eligibility check request. The response will always include either the subscriber's name or member ID for identification, but most payers will also return the subscriber's date of birth and other identifying information. source: healthcare type: object - name: ResponseSubscriberEntityIdentifier description: The entity identifier for the subscriber. source: healthcare type: string - name: ResponsibleParty description: The party responsible for completing a task. source: enrollment type: string - name: RetryEventResponseContent description: Schema type from the Stedi core API source: core type: object - name: RetryExecutionSelectionCondition description: 'Specify the file executions to retry. Stedi will retry all executions matching the given criteria. For example, you can retry all file executions with a `FAILED` status within a specific date range. Note that Stedi only retries each `executionId` once. Each retry attempt is stored as a new file execution within Stedi. If you need to retry a file multiple times, you''ll need to pass the ID of the latest retry attempt to this endpoint.' source: core type: object - name: RetryExecutionsRequestContent description: Schema type from the Stedi core API source: core type: object - name: SearchPayerRecord description: Schema type from the Stedi healthcare API source: healthcare type: object - name: SearchPayerTransactionSupport description: 'Whether the following transaction types are supported: 270 eligibility checks, 276/277 claim status requests, 837 claims (professional, dental, institutional), 835 ERAs (claim payments), 275 unsolicited claim attachments, and coordination of benefits checks. If the value is `ENROLLMENT_REQUIRED`, Stedi supports the transaction type, but you must [enroll with the payer](https://www.stedi.com/docs/healthcare/supported-payers#enrollment) first.' source: healthcare type: object - name: SearchPayersResponseContent description: Common output structure for list operations with pagination support. source: healthcare type: object - name: SearchResult description: Schema type from the Stedi healthcare API source: healthcare type: object - name: SearchResultsStats description: Schema type from the Stedi healthcare API source: healthcare type: object - name: SecondaryIdentifierTypeCode description: Code identifying the type of secondary identifier. Can be set to `2U` - Payer Identification Number, `FY` - Claim Office Number, or `NF` - National Association of Insurance Commissioners. You should only set this to `2U` when you set the `primaryIdentifierTypeCode` to `XV`. source: healthcare type: string - name: SenderAccountDetails description: Financial institution account details for the payment sender. source: healthcare type: object - name: Service description: Information about a service line listed in the referenced claim. source: healthcare type: object - name: ServiceAuthorizationExceptionCode description: Code indicating the reason for the service authorization exception. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#service-authorization-exception-codes) for a complete list. source: healthcare type: string - name: ServiceClaimStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceDetail description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceEntityIdentifierCode description: Entity identifier code for service lines in claim status reports source: healthcare type: string - name: ServiceEntityIdentifierCodeValue description: Human-readable descriptions for service entity identifier codes source: healthcare type: string - name: ServiceExceptionResponseContent description: Schema type from the Stedi core API source: core type: object - name: ServiceFacilityLocationSecondaryIdentificationQualifierCode description: Code identifying the type of secondary identification. Can be set to `0B` - State License Number, `G2` - Provider Commercial Number, or `LU` - Location Number. source: healthcare type: string - name: ServiceFacilityLocationSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceIdQualifierCode description: A code identifying the type/source of the `procedureId`. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#product-or-service-id-qualifier) for a complete list. source: healthcare type: string - name: ServiceLine description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineDateInformation description: Identify specific dates related to the service rendered. source: healthcare type: object - name: ServiceLineInformation description: Identify a service line listed in the referenced claim. Used to request status for a specific service line. source: healthcare type: object - name: ServiceLineOrderingProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineOrderingProviderSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineProviderPurchasedService description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLinePurchasedServiceProviderSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineReferenceInformation description: Additional identifiers for the service line. source: healthcare type: object - name: ServiceLineReferringProviderIdentificationQualifierCode description: The type of identifier used in `secondaryIdentifier`. Can be set to `0B` - State License Number, `1G` - Provider UPIN Number, or `G2` - Provider Commercial Number. Note that UPIN is deprecated and should not be used. source: healthcare type: string - name: ServiceLineReferringProviderSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineRenderingProviderSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineResponseIdentifier description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineServiceFacilityLocation description: 'Required when the location for the service is different from the billing provider''s address. The purpose of this object is to identify specifically where the service was rendered. This can be healthcare facilities, such as surgical centers or reference labs, OR the patient''s address when services were rendered in their home. - Only include this object when the service facility location is **different** from the billing provider''s address. If you include this object when the address is the same, Stedi omits all of the service facility location information from the claim submission, including the name and any identifiers. - 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. - Don''t use this object when reporting ambulance services - use `ambulancePickupLocation` and `ambulanceDropoffLocation` instead. - Sometimes the billing provider is an actual physician group that is located at the same address as a hospital, but is in fact a separate entity. In this case, you can differentiate the service facility location by including the specific suite or building number of the physician group. This ensures that the service facility location is different from the billing provider''s address and is reported accurately.' source: healthcare type: object - name: ServiceLineStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineSupervisingProviderSecondaryIdentifierItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceLineSupplementalInformationAttachmentReportTypeCode description: Code indicating the title or contents of a document, report or supporting item. For example, `08` - Plan of Treatment or `CT` - Certification. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#attachment-report-type-codes) for a complete list. source: healthcare type: string - name: ServiceLineSupplementalInformationAttachmentTransmissionCode description: Code indicating the method by which the attachment was transmitted. Can be set to `AA` - Available on Request at Provider Site, `BM` - By Mail, `EL` - Electronically Only, `EM` - E-Mail, `FT` - File Transfer, or `FX` - By Fax. source: healthcare type: string - name: ServiceProviderClaimStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ServiceUnavailableExceptionResponseContent description: The server cannot handle the request due to technical reasons. source: core type: object - name: SignatureIndicator description: Indicates whether the provider's signature is on file. Can be set to `N` - No or `Y` - Yes. source: healthcare type: string - name: SpecialProgramCode description: Code indicating the Special Program under which the services rendered to the patient were performed. Used for Medicaid claims only. Can be set to `02` - Physically Handicapped Children's Program, `03` - Special Federal Funding, `05` - Disability, or `09` - Second Opinion or Surgery. source: healthcare type: string - name: SpinalManipulationServiceInformation description: Information about a chiropractic service rendered to the patient. Required on chiropractic claims involving spinal manipulation when the information is known to impact the payer's adjudication process. source: healthcare type: object - name: Status description: Information about the status, required action, and paid information of a service line. source: healthcare type: object - name: StatusRequestProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: StatusResponseProvider description: Schema type from the Stedi healthcare API source: healthcare type: object - name: SubmitClaimAttachmentRawX12403ErrorResponseContent description: Schema type from the Stedi claims API source: claims type: object - name: SubmitClaimAttachmentRawX12RequestContent description: Request to submit a raw X12 claim attachment source: claims type: object - name: SubmitClaimAttachmentRawX12ResponseContent description: Response from submitting a raw X12 claim attachment source: claims type: object - name: Submitter description: The entity submitting the healthcare claim. This can be either an individual or an organization, such as a doctor, hospital, or insurance company. You must submit at least `organizationName` or `lastName` properties and the `contactInformation` object. If you don't supply the `submitterIdentification` property, Stedi uses the value from `billing.npi` in the request. source: healthcare type: object - name: Subscriber description: 'The person or entity who is the primary policyholder for the health plan _or_ a dependent with their own member ID. The subscriber can be an individual or a business entity. - When a dependent has a unique, payer-assigned member ID, treat them as the `subscriber` for the claim submission - include their information here and omit the `dependent` object from the request. Stedi treats the subscriber as an individual when the request doesn''t contain a value for the `subscriber.organizationName` property. - You must set the `dateOfBirth` and `gender` properties when the subscriber is the patient. Stedi determines that the subscriber is the patient when the `dependent` object is not included in the request. - If either `dateOfBirth` or `gender` is set, you must include both properties. You can either include both properties or neither within a single request. - You must include `address` in this object when the patient is the subscriber. If the patient is a dependent, include address information in the `dependent` object instead.' source: healthcare type: object - name: SubscriberGender description: "Identifies the subscriber's gender. Can be set to `F` - Female, `M`\ \ - Male, or `U` - Unknown. \n\nThis property is **required** if the subscriber\ \ is an individual. \n\nYou should set this property to `U` when the patient declines\ \ to answer or does not identify as male or female. Note that some payers may\ \ reject the claim if the patient's gender doesn't match the gender they have\ \ recorded in their member records." source: healthcare type: string - name: SubscriberInsuranceTypeCode description: Identifies the type of insurance policy within a specific insurance program. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#insurance-type-codes) for a complete list. source: healthcare type: string - name: SubscriberInsuredIndicator description: Indicates the status of the insured. For the subscriber, this is always `Y`. source: healthcare type: string - name: SubscriberPaymentResponsibilityLevelCode description: "Code identifying the payer's level of responsibility for paying this\ \ claim. Visit [Claims code lists](https://www.stedi.com/docs/healthcare/claims-code-lists#payment-responsibility-sequence-number-codes)\ \ for a complete list of possible codes.\n - Stedi sets this property to `P`\ \ - Primary by default. You only need to include it when you need to submit codes\ \ other than `P`. This can happen when the patient has multiple insurance policies.\ \ For example, if a patient is covered by both Medicare and an employer-sponsored\ \ commercial plan, you could bill the commercial plan first as `P` and then bill\ \ the Medicare payer second as `S`.\n - Either this property or `otherSubscriberInformation.paymentResponsibilityLevelCode`\ \ must be set to `P` to indicate the primary insurance payer. Stedi rejects claims\ \ - including secondary and tertiary claims - that don't include information for\ \ the primary payer." source: healthcare type: string - name: SubscriberRelationship description: The name of the `relationToSubscriberCode`. For the subscriber, this is always `Self`. source: healthcare type: string - name: SubscriberRelationshipCode description: For the subscriber, this is always `18` for Self. source: healthcare type: string - name: SubscriberTraceNumber description: Schema type from the Stedi healthcare API source: healthcare type: object - name: Supervising description: 'The entity responsible for overseeing the rendering provider and the care reported in this claim. Applies when the rendering provider is supervised by a physician. Use when the provider applies to the entire claim, not just a specific service line. This should be an individual, not an organization, and you should supply at least the provider''s `lastName` and an identifier, which is typically the `npi`.' source: healthcare type: object - name: SupportedAggregationType description: 'Aggregation types a payer supports for 835 Electronic Remittance Advice (ERA) transactions. Payers can aggregate by the provider''s NPI, tax ID (TIN), or both. You can use this information to specify an `aggregationPreference` when submitting ERA enrollment requests.' source: healthcare type: string - name: SupportedBreakdown description: Schema type from the Stedi healthcare API source: healthcare type: object - name: SupportingDocumentation description: Use to provide information in response to a coded questionnaire document. source: healthcare type: object - name: Task description: A task representing work that needs to be completed. source: enrollment type: object - name: TaskDefinition description: A discriminated union of task definitions. Supports multiple task types with future extensibility. source: enrollment type: object - name: TaskResponseData description: A discriminated union of task response data. Contains structured data collected when completing specific task types. source: enrollment type: object - name: TaxIdType description: The type of tax identification number. source: enrollment type: string - name: TechnicalContactInformation description: Technical contact information for the payer. source: healthcare type: object - name: TechnicalContactMethod description: Contact method details for technical support. source: healthcare type: object - name: ThrottlingExceptionResponseContent description: The server response when usage plan or account-level throttling limits exceeded. source: core type: object - name: TimePeriodQualifier description: 'The name of the `timePeriodQualifierCode`. For example, `Calendar Year`. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: TimePeriodQualifierCode description: 'Code specifying the time period for the benefit information. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: TimeQualifierCode description: 'Code indicating the time period for the benefit information. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: TimeQualifierName description: "The name of the time period qualifier code. \n \n Note that for the\ \ patient's deductible, `Calendar Year` indicates the patient's total deductible\ \ amount for the year, while `Remaining` indicates the amount left to meet the\ \ deductible. Visit [Payer benefit response](https://www.stedi.com/docs/healthcare/eligibility-patient-responsibility-benefits#deductible)\ \ to learn more about deductibles.\n\nPayers may sometimes return other non-compliant\ \ values." source: healthcare type: string - name: ToothInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ToothStatus description: Schema type from the Stedi healthcare API source: healthcare type: object - name: ToothStatusCode description: Can be set to `E` - To Be Extracted, `M` - Missing. source: healthcare type: string - name: ToothSurfaceCode description: Schema type from the Stedi healthcare API source: healthcare type: string - name: TraceTypeCode description: Identifies the type of trace number used to uniquely identify and track payment transactions. This helps reassociate payments with their corresponding remittance advice. source: healthcare type: string - name: TradingPartnerSecondaryIdentifiers description: Secondary identifiers for the payer. You can include up to three properties in this object. source: healthcare type: object - name: TransactionEnrollmentProcesses description: Information about the transaction enrollment requirements and expected timeframes for each transaction type. source: healthcare type: object - name: TransactionFilterValue description: Transaction support filter values. When multiple transaction filters are specified, they are combined with AND logic (payers must satisfy **all** criteria). source: healthcare type: string - name: TransactionFragmentsSummary description: Details about fragments included in the transaction, if applicable. Fragments break large transactions into smaller parts for easier processing and management. source: core type: object - name: TransactionGroup description: A transaction group contains data for one or more EDI transactions in [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format. source: core type: object - name: TransactionGroupOverrides description: Customize the Application IDs for you or your trading partner. source: core type: object - name: TransactionHandlingCode description: Indicates the actions that should be taken by both the sender and receiver of the payment transaction. This determines whether payment should be made, remittance sent, or both. source: healthcare type: string - name: TransactionIdentifier description: Schema type from the Stedi healthcare API source: healthcare type: object - name: TransactionOrdering description: 'Specify the order of the transactions in the generated X12 EDI file. By default, Stedi doesn''t guarantee any particular order. Set to `CONTROL_NUMBER` to order transactions within a functional group by their control number, from lowest to highest. In X12 EDI, this is `ST02` (Transaction Set Control Number).' source: core type: string - name: TransactionStatus description: A status indicating whether Stedi was able to successfully process the transaction. source: core type: string - name: TransactionSummary description: The processed transactions that match the request criteria. The `items` array is empty if there are no matching transactions. source: core type: object - name: TransactionSupport description: 'Whether the following transaction types are supported: 270 eligibility checks, 276 claim status requests, 837 professional claims, and 835 ERAs (claim payments). If the value is `ENROLLMENT_REQUIRED`, Stedi supports the transaction type, but you must [enroll with the payer](https://www.stedi.com/docs/healthcare/supported-payers#enrollment) first.' source: healthcare type: object - name: TransactionSupportCounts description: Schema type from the Stedi healthcare API source: healthcare type: object - name: TransactionSupportCountsItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: TransactionSupportStats description: Schema type from the Stedi healthcare API source: healthcare type: object - name: TransactionSupportStatsItem description: Schema type from the Stedi healthcare API source: healthcare type: object - name: TransactionSupportValue description: Schema type from the Stedi healthcare API source: healthcare type: string - name: TransactionType description: Types of healthcare transactions supported for enrollment. source: enrollment type: string - name: TranslationError description: Schema type from the Stedi core API source: core type: object - name: TranslationErrorContext description: Schema type from the Stedi core API source: core type: object - name: UnauthorizedExceptionResponseContent description: The server response when the authorizer failed to authenticate the caller. source: core type: object - name: UnitForMeasurement description: 'The name of the `unitForMeasurementQualifierCode`. For example, `Days`. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: UnitForMeasurementCode description: 'Code specifying the unit of measurement for the quantity. Payers may sometimes return other non-compliant values.' source: healthcare type: string - name: UnprocessableEntityExceptionResponseContent description: The request parameters do not match a previous request with the same idempotency key. source: core type: object - name: UnsolicitedClaimAttachmentEnrollmentProcess description: Details about the enrollment process for unsolicited claim attachments. source: healthcare type: object - name: UpdateEnrollmentRequestContent description: Input for UpdateEnrollment. source: enrollment type: object - name: UpdateEnrollmentResponseContent description: Output containing the updated enrollment details. source: enrollment type: object - name: UpdateProviderRequestContent description: Input for UpdateProvider. source: enrollment type: object - name: UpdateProviderResponseContent description: Output containing the updated provider details. source: enrollment type: object - name: UpdateTaskPostRequestContent description: Input for UpdateTaskPost operation. Identical to UpdateTaskInput. source: enrollment type: object - name: UpdateTaskPostResponseContent description: Output for UpdateTaskPost operation. Identical to UpdateTaskOutput. source: enrollment type: object - name: UsState description: United States state and territory codes using standard two-letter abbreviations. source: enrollment type: string - name: V1EventPayload description: A v1 thin event envelope that signals a state change. Consumers fetch current resource state via API using the resource reference. This is the exact payload delivered to webhook destinations. source: event-destinations type: object - name: ValidationException description: 'A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.' source: healthcare type: object - name: ValidationExceptionField description: Describes one specific validation failure for an input member. source: healthcare type: object - name: ValidationExceptionResponseContent description: 'A standard error for input validation failures. Thrown when a member of the input structure falls outside of the modeled or documented constraints.' source: healthcare type: object - name: ValueInformation description: Schema type from the Stedi healthcare API source: healthcare type: object - name: Warning description: Schema type from the Stedi healthcare API source: healthcare type: object - name: X12AcknowledgmentRequestedCode description: Set [ISA-14](https://www.stedi.com/edi/x12/segment/ISA#ISA-14) to a different value. If not set, the default value is `0 (No Interchange Acknowledgment Requested)`. source: core type: string - name: X12AuthorizationInformationQualifier description: Identifies the type of information in the Authorization Information (`ISA-01`). Default is `00 - No Authorization Information Present`. source: core type: string - name: X12Delimiters description: Schema type from the Stedi core API source: core type: object - name: X12InterchangeAuthorization description: Set values for [ISA header](https://www.stedi.com/edi/x12/segment/ISA) elements (ISA-01 to ISA-04). source: core type: object - name: X12InterchangeQualifier description: Schema type from the Stedi core API source: core type: string - name: X12SecurityInformationQualifier description: Identifies the type of information in the Security Information (ISA-03). Default is `00 - No Security Information Present`. source: core type: string - name: X12TransactionMetadata description: Metadata about the X12 EDI transaction, including information from the interchange, functional group, and transaction headers as well as the sender and receiver IDs. source: core type: object - name: X12TransactionMetadataFunctionalGroup description: Data from the Functional Group Header of the X12 EDI file. source: core type: object - name: X12TransactionMetadataInterchange description: Data from the Interchange Control Header of the X12 EDI file. source: core type: object - name: X12TransactionMetadataProfile description: The Application Code and ISA ID for the profile. source: core type: object - name: X12TransactionMetadataProfileISA description: The Interchange ID and qualifier. source: core type: object - name: X12TransactionMetadataTransaction description: Data from the Transaction Set Header of the X12 EDI file. source: core type: object - name: X12TransactionSetIdentifierCode description: 'Any valid 3-digit X12 Transaction Set Identifier Code, as defined in the X12 standard. See: .' source: core type: string - name: X12TransactionSetting description: The IDs for the guide and transaction setting Stedi used to process the transaction. source: core type: object - name: X12TransactionSummary description: Details about the X12 EDI transaction. source: core type: object - name: X12UsageIndicator description: Set [ISA-15](https://www.stedi.com/edi/x12/segment/ISA#ISA-15) to a different value. If not set, the default value is `P (Production Data)`. source: core type: string