ClaimSoft integration

Query Claim Detail by Status

Perform Query Claim Detail by Status through ClaimSoft.

View as Markdown

claimsoft_query_claim_detail_by_status

writeclaimsoft

Inputs

report
selectrequired
Report
Required selected identifier or value.
Options: ByAlert ("ByAlert"), ByPatient ("ByPatient"), BySalesperson ("BySalesperson"), ByHCPCS ("ByHCPCS"), ByPSR ("ByPSR"), ByPractitioner ("ByPractitioner"), ByPrimaryPayer ("ByPrimaryPayer"), BySecondaryPayer ("BySecondaryPayer")
selected_ids
json
Selected Ids
Optional JSON value.
billing_location_ids
json
Billing Location Ids
Optional JSON value.
begin_date
daterequired
Begin Date
Required date in YYYY-MM-DD format.
end_date
daterequired
End Date
Required date in YYYY-MM-DD format.
date_basis
select
Date Basis
Optional selected identifier or value.
Default: "OrderCreated"
Options: OriginalBilled ("OriginalBilled"), SecondaryBilled ("SecondaryBilled"), PrimaryBilled ("PrimaryBilled"), PatientBilled ("PatientBilled"), ServiceDate ("ServiceDate"), ReorderDate ("ReorderDate"), OrderCreated ("OrderCreated"), AuthExpiration ("AuthExpiration")
statuses
json
Statuses
Optional JSON value.
Options: InProcess ("InProcess"), Scheduled ("Scheduled"), Submitted ("Submitted"), Closed ("Closed"), BilledOpen ("BilledOpen"), ReProcess ("ReProcess")
detail_level
select
Detail Level
Optional selected identifier or value.
Default: "Items"
Options: Full claim details ("Items"), Claim summary ("Claims")
include_claim_comments
boolean
Include Claim Comments
Optional true-or-false value.
Default: true
include_no_payer
boolean
Include No Payer
Optional true-or-false value.
Default: false
ignore_location_sorting
boolean
Ignore Location Sorting
Optional true-or-false value.
Default: false
timely_filing_min
text
Timely Filing Min
Optional text value.
timely_filing_max
text
Timely Filing Max
Optional text value.
max_rows
number
Max Rows
Optional numeric value.
Default: 500
skip_rows
number
Skip Rows
Optional numeric value.
Default: 0
poll_interval_seconds
number
Poll Interval Seconds
Optional numeric value.
Default: 15
timeout_seconds
number
Timeout Seconds
Optional numeric value.
Default: 600

Outputs

successSuccess
report_idReport Id
report_nameReport Name
totalTotal
rowsRows
order_idsOrder Ids
report_parametersReport Parameters
report_jsonReport Json
truncatedTruncated
report_run_idReport Run Id
report_statusReport Status
created_dateCreated Date
storage_keyStorage Key
filenameFilename
mime_typeMime Type
size_bytesSize Bytes
download_urlDownload Url
pollsPolls
errorError

Output schema completeness: best_effort_declared

Safety

External effect: write
Confirmation recommended: No
Retry safe: No
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "required": [
    "report",
    "begin_date",
    "end_date"
  ],
  "properties": {
    "report": {
      "enum": [
        "ByAlert",
        "ByPatient",
        "BySalesperson",
        "ByHCPCS",
        "ByPSR",
        "ByPractitioner",
        "ByPrimaryPayer",
        "BySecondaryPayer"
      ],
      "type": "string",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "max_rows": {
      "type": "number",
      "default": 500,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "statuses": {
      "enum": [
        "InProcess",
        "Scheduled",
        "Submitted",
        "Closed",
        "BilledOpen",
        "ReProcess"
      ],
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "skip_rows": {
      "type": "number",
      "default": 0,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "begin_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "date_basis": {
      "enum": [
        "OriginalBilled",
        "SecondaryBilled",
        "PrimaryBilled",
        "PatientBilled",
        "ServiceDate",
        "ReorderDate",
        "OrderCreated",
        "AuthExpiration"
      ],
      "type": "string",
      "default": "OrderCreated",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "detail_level": {
      "enum": [
        "Items",
        "Claims"
      ],
      "type": "string",
      "default": "Items",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "selected_ids": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "timeout_seconds": {
      "type": "number",
      "default": 600,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "include_no_payer": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "timely_filing_max": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "timely_filing_min": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "billing_location_ids": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "poll_interval_seconds": {
      "type": "number",
      "default": 15,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "include_claim_comments": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "ignore_location_sorting": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "rows": {},
    "error": {},
    "polls": {},
    "total": {},
    "success": {},
    "filename": {},
    "mime_type": {},
    "order_ids": {},
    "report_id": {},
    "truncated": {},
    "size_bytes": {},
    "report_json": {},
    "report_name": {},
    "storage_key": {},
    "created_date": {},
    "download_url": {},
    "report_run_id": {},
    "report_status": {},
    "report_parameters": {}
  },
  "additionalProperties": true
}

View all ClaimSoft actions