Retrieves outstanding balances for a single order ID across all balance categories (order-writeoff, unallocated, institution invoices, institution uninvoiced, patient responsibility).

Get outstanding balances for a single order

Outstanding balances retrieved successfully.

An unexpected error occurred while retrieving balances.

Sample Healthcare

Introduction

Quickstart

Workflows and Steps

Learn how to structure workflow execution

Control Flow

Understanding the workflow context and how to access data between steps

Workflow Context

Adding custom column displays to workflow steps

Column Values

Using suspend and resume to wait for async results

Async Results

Calling the Sample API

Starting Workflows

Managing environment variables in Sample Workflows

Environment Variables

Creating interactive user interfaces within workflows

Intro to Screens

How to authenticate with the SampleHC API

Authentication

Sample provides a fully managed, autoscaling PostgreSQL database powered by AWS for storing data between and across workflows.

Database

Allows execution of arbitrary SQL queries against the Sample database. Supports parameterized queries.

Execute SQL query

Retrieves audit logs. Allows for filtering and searching through historical audit data.

Query audit logs

Start workflow

Queries outputs from a specific workflow run using a SQL-like language. Returns results as a JSON array.

Query workflow outputs

Retrieves the complete details of a specific workflow run by its ID.

Workflow run details

Requests cancellation of a currently active workflow run. This is an asynchronous operation and the run may take some time to fully stop.

Cancel workflow run

Retrieves a specific screen asset for a given workflow run. The asset path is specified by the wildcard part of the URL.

Workflow run screen asset

Get apiv2workflow runscurrent task

Retrieves the output data of a specific step within a workflow run. This endpoint requires an ExecuteStepRequestContext with `workflowRunId` and `stepAddr`.

Step output

Retrieves the initial data (startData) that was used to initiate the current workflow run. This endpoint requires an ExecuteStepRequestContext with a `workflowRunId`.

Workflow run start data

Registers an asynchronous task's result ID to resume a workflow run upon its completion. This endpoint requires an ExecuteStepRequestContext with `workflowRunId` and `stepAddr`.

Resume workflow after async task

Marks a specified task as complete, providing the result of its execution. This may trigger the next task in the workflow.

Complete task

Marks a specified task as cancelled, preventing it from being executed. This also halts the execution of any subsequent tasks in the workflow.

Cancel task

Retrieves the payload with which a task was suspended, typically for tasks awaiting external interaction or data.

Suspended task payload

Attempts to retry a failed task. This will re-queue the task for execution.

Retry task

Adds a specified duration to the total screen time recorded for a task. This is typically used for tasks involving user interaction.

Update task screen time

Get task

Retrieves the state of a task. This is typically used for tasks that need to persist state across multiple requests.

Get task state

Update task state

Initiates a workflow run based on its slug. Accepts JSON or multipart/form-data for input.

Start workflow by slug

Creates a new deployment for the specified workflow ID, making the current version of the workflow live.

Deploy workflow

Retrieves metadata for a specific document, including a presigned URL for direct access if applicable.

Document metadata

Retrieves comprehensive details for a specific document, including its content or OCR data if available, and a presigned URL.

Full document details

Retrieves the content of a CSV document as a structured JSON array.

Document CSV content

Given a document ID representing a ZIP file, unzip it, traverse the directory structure and return all PDFs found as a list of documents

Unzip file and return PDFs

Creates a new CSV document from the provided rows of data and returns the new document's metadata.

Generate CSV document

Generates a presigned URL that can be used to directly upload a file to storage. Returns the URL and document metadata.

Presigned URL for upload

Initiates an asynchronous document classification process based on provided schemas. Returns an ID to track the async result.

Classify document (async)

Initiates an asynchronous document splitting process. Returns an ID to track the async result.

Split document (async)

Creates new documents from specified page splits of an existing document.

Create documents from splits

Initiates an asynchronous legacy data extraction process. Returns an ID to track the async result.

Legacy extract document (async)

Initiates a modern, flexible asynchronous data extraction process using a JSON schema for the desired output and a prompt. Returns an ID for tracking.

Document extraction (async)

Renders a document body from a template slug and variables and returns the JSON content. Variables can be strings or arrays of objects for table data.

Render document body

Initiates an asynchronous process to generate a document from a template slug and relevant data (documentBody for document, variables for PDF). Returns an ID for tracking.

Generate document from template (async)

Transforms a Sample JSON document to HTML

Transform JSON to HTML

Initiates an asynchronous document reasoning process based on a task. Returns an ID for tracking.

Document reasoning (async)

Performs a search query across a specified set of documents and returns matching results.

Search across documents

Retrieves document metadata for a PDF template by slug, including a presigned URL for direct access.

PDF template document metadata

Combines multiple PDF documents into a single PDF and returns the combined document's metadata.

Combine PDF documents

Retrieves the status and result of an asynchronous operation.

Async result

Creates an async result that will automatically resolve after a specified delay or at a future time.

Sleep (async)

Processes and dispatches an email. Supports plain text and encrypted emails. Attachments can be provided by ID, optionally zipped together before sending. Encrypted emails are stored and a notification link is sent.

Send email

Initiates an asynchronous fax sending process. Returns an async result ID that can be used to track the status of the fax transmission.

Send fax

Calculates the cost of a patient's services based on the provided information.

Calculate patient cost for a line item

Lists all payers available for eligibility checks.

List payers

Searches for payers based on the provided search criteria.

Search payers

Verifies patient eligibility with a specific payer for given services based on the provided patient and provider information.

Check payer eligibility

Submits an electronic claim for processing. The submission is handled asynchronously, and this endpoint returns an identifier to track the status of the claim submission.

Submit electronic claim

Retrieves the status and details of a submitted claim by its ID.

Get claim status

Voids a previously submitted claim by submitting a new claim with claimFrequencyCode set to 8.

Cancel electronic claim

Fetches coordination of benefits (COB) information for a patient from a specified payer, detailing other insurance coverages.

Retrieve coordination of benefits (COB)

Creates a new ledger entry for an order, linking claim, institution, patient, and insurance financial details. All monetary amounts should be provided in cents.

Create new ledger order

Posts a patient adjustment to the ledger. All monetary amounts should be provided in cents.

Post patient adjustment

Posts an institution adjustment to the ledger. All monetary amounts should be provided in cents.

Post institution adjustment

Posts a claim adjustment to the ledger. All monetary amounts should be provided in cents.

Post claim adjustment

Posts a claim payment to the ledger. All monetary amounts should be provided in cents.

Post claim payment

Posts a patient payment to the ledger. All monetary amounts should be provided in cents.

Post patient payment

Posts an institution payment to the ledger. All monetary amounts should be provided in cents.

Post institution payment

Posts an order write-off to the ledger. All monetary amounts should be provided in cents.

Post order write-off

Assigns an invoice to an institution for a given order.

Post invoice assignment

Given a ledger entry ID, posts its reversal entry.

Reverse a ledger entry

Retrieves all outstanding orders for a specific institution (accounts with non-zero balances).

Get outstanding institutional orders

Retrieves all outstanding institutional accounts across all institutions (accounts with non-zero balances).

Get all outstanding institutional accounts

Retrieves all outstanding insurance accounts across all insurance payors (claims with non-zero balances).

Get all outstanding insurance accounts

Retrieves all outstanding patient accounts across all patients (accounts with non-zero balances).

Get all outstanding patient accounts

Retrieves the balance for a specific institutional order.

Get institutional order balance

Retrieves outstanding balances for an array of order IDs across all balance categories (order-writeoff, unallocated, institution invoices, institution uninvoiced, patient responsibility).

Get outstanding balances for multiple orders

Execute a query against a configured Snowflake instance.

Query Snowflake

Retrieves a specific screen asset for a given dashboard. The asset path is specified by the wildcard part of the URL.

Dashboard screen asset

Create event

Upserts a patient and triggers jobs to get patient FHIR data and documents from HIE.

Upsert patient and get all data

Contributes a document to the HIE network for a specific patient.

Contribute document to HIE

Initiates an asynchronous process to submit an appeal to Availity. Returns an ID for tracking.

v1

Workflow-run

Task

Workflow

Document

Async-result

Communication

Clearinghouse

Ledger

Integration - Snowflake

Dashboard

Events

HIE

Browser Automation

Get outstanding balances for a single order

Path Parameters

Response