{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Stedi Claims Schemas",
  "definitions": {
    "AccessDeniedException": {
      "description": "The server response for authorization failure.",
      "properties": {
        "code": {
          "description": "Error classification code",
          "type": "string"
        },
        "message": {
          "description": "Human-readable error message",
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "AccessDeniedExceptionResponseContent": {
      "description": "The server response for authorization failure.",
      "properties": {
        "code": {
          "description": "Error classification code",
          "type": "string"
        },
        "message": {
          "description": "Human-readable error message",
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "AttachmentsResponseMetadata": {
      "description": "Metadata from Stedi about the request.",
      "properties": {
        "traceId": {
          "description": "A unique identifier assigned to the processed file within the Stedi platform. This is also known as the file execution ID.",
          "maxLength": 36,
          "minLength": 36,
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ClaimAttachmentReference": {
      "description": "Information about the claim attachment.",
      "properties": {
        "correlationId": {
          "description": "An opaque string identifier Stedi assigns to the claim attachment. You can use it for tracking purposes and when contacting Stedi support.",
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "patientControlNumber": {
          "description": "The `patientControlNumber` from the claim associated with this attachment, if supplied. This is a unique identifier that you assigned to the related claim so you can track the claim and correlate it with responses from the payer.",
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "timeOfResponse": {
          "description": "A timestamp in [RFC 3339 format](https://datatracker.ietf.org/doc/html/rfc3339) for Stedi's response to the submission. For example: `2025-03-07T12:34:56Z`.",
          "format": "date-time",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ContentType": {
      "description": "Allowed content types for claim attachments.",
      "enum": [
        "application/pdf",
        "image/tiff",
        "image/jpeg",
        "image/jpg",
        "image/png"
      ],
      "type": "string"
    },
    "CreateClaimAttachmentFileRequestContent": {
      "description": "Request a pre-signed URL to upload a claim attachment file.",
      "properties": {
        "contentType": {
          "$ref": "#/components/schemas/ContentType",
          "description": "The MIME type of the attachment file. For example: `image/png` or `application/pdf`."
        }
      },
      "required": [
        "contentType"
      ],
      "type": "object"
    },
    "CreateClaimAttachmentFileResponseContent": {
      "description": "Receive the attachment ID and upload URL.",
      "properties": {
        "attachmentId": {
          "description": "Unique identifier for this attachment. You will use this ID to associate the attachment file with the claim when you submit it to the payer.",
          "maxLength": 36,
          "minLength": 36,
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
          "type": "string"
        },
        "uploadUrl": {
          "description": "A pre-signed URL you can use to upload the file with a `PUT` request. The `PUT` request must include a `Content-Type` header that matches the MIME type you specified for the attachment file.",
          "maxLength": 2000,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "attachmentId",
        "uploadUrl"
      ],
      "type": "object"
    },
    "InternalFailureExceptionResponseContent": {
      "description": "The server response when an unexpected error occurred while processing request.",
      "properties": {
        "code": {
          "description": "Error classification code",
          "type": "string"
        },
        "message": {
          "description": "Human-readable error message",
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "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.",
      "properties": {
        "message": {
          "description": "Human-readable error message describing why the interchange envelope was rejected and how to remediate it.",
          "type": "string"
        },
        "x12": {
          "description": "The X12 TA1 interchange acknowledgment document indicating the rejection.",
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "ResourceNotFoundExceptionResponseContent": {
      "description": "Exception returned when the specified resource cannot be found.",
      "properties": {
        "code": {
          "description": "Unique error code identifying the specific type of resource not found error.",
          "type": "string"
        },
        "message": {
          "description": "Human readable error message explaining why the resource could not be found.",
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "SubmitClaimAttachmentRawX12403ErrorResponseContent": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/InvalidInterchangeEnvelopeException"
        },
        {
          "$ref": "#/components/schemas/AccessDeniedException"
        }
      ]
    },
    "SubmitClaimAttachmentRawX12RequestContent": {
      "description": "Request to submit a raw X12 claim attachment",
      "properties": {
        "x12": {
          "description": "The X12 EDI data for the claim attachment. This data must conform to the [275 X12 EDI specification](https://portal.stedi.com/app/guides/view/hipaa/patient-information-x210/01HQ4HZ8ZBY2CZGPCVVM8JTK22).",
          "maxLength": 6000000,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "x12"
      ],
      "type": "object"
    },
    "SubmitClaimAttachmentRawX12ResponseContent": {
      "description": "Response from submitting a raw X12 claim attachment",
      "properties": {
        "claimAttachmentReference": {
          "$ref": "#/components/schemas/ClaimAttachmentReference",
          "description": "Information about the claim attachment."
        },
        "meta": {
          "$ref": "#/components/schemas/AttachmentsResponseMetadata",
          "description": "Metadata from Stedi about the request."
        },
        "tradingPartnerServiceId": {
          "description": "An ID for the payer you identified in the related transaction. This value may differ from the `tradingPartnerServiceId` you submitted in the original claim request because it reflects the payer's internal concept of their ID, not necessarily the ID Stedi uses to route requests to this payer.",
          "maxLength": 80,
          "minLength": 2,
          "type": "string"
        }
      },
      "type": "object"
    },
    "ThrottlingExceptionResponseContent": {
      "description": "The server response when usage plan or account-level throttling limits exceeded.",
      "properties": {
        "code": {
          "description": "Error classification code",
          "type": "string"
        },
        "message": {
          "description": "Human-readable error message",
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "ValidationExceptionField": {
      "description": "Describes one specific validation failure for an input member.",
      "properties": {
        "message": {
          "description": "A detailed description of the validation failure.",
          "type": "string"
        },
        "path": {
          "description": "A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.",
          "type": "string"
        }
      },
      "required": [
        "message",
        "path"
      ],
      "type": "object"
    },
    "ValidationExceptionResponseContent": {
      "description": "A standard error for input validation failures.\nThis should be thrown by services when a member of the input structure\nfalls outside of the modeled or documented constraints.",
      "properties": {
        "fieldList": {
          "description": "A list of specific failures encountered while validating the input.\nA member can appear in this list more than once if it failed to satisfy multiple constraints.",
          "items": {
            "$ref": "#/components/schemas/ValidationExceptionField"
          },
          "type": "array"
        },
        "message": {
          "description": "A summary of the validation failure.",
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    }
  }
}