# Sample Healthcare

## Docs

- [Async result](https://docs.samplehc.com/api-reference/async-result/async-result.md): Retrieves the status and result of an asynchronous operation.
- [Sleep (async)](https://docs.samplehc.com/api-reference/async-result/sleep-async.md): Creates an async result that will automatically resolve after a specified delay or at a future time.
- [Sync bank transactions](https://docs.samplehc.com/api-reference/bank/sync-bank-transactions.md)
- [Create billing event](https://docs.samplehc.com/api-reference/billing-events/create-billing-event.md)
- [Create or update a Candid Health connection](https://docs.samplehc.com/api-reference/candid-health/create-or-update-a-candid-health-connection.md)
- [Fetch patient details from Candid Health (async)](https://docs.samplehc.com/api-reference/candid-health/fetch-patient-details-from-candid-health-async.md)
- [Get a patient by MRN from Candid Health](https://docs.samplehc.com/api-reference/candid-health/get-a-patient-by-mrn-from-candid-health.md)
- [Get all payers from Candid Health](https://docs.samplehc.com/api-reference/candid-health/get-all-payers-from-candid-health.md)
- [Get Candid Health connection details](https://docs.samplehc.com/api-reference/candid-health/get-candid-health-connection-details.md)
- [Get coverages for a patient from Candid Health](https://docs.samplehc.com/api-reference/candid-health/get-coverages-for-a-patient-from-candid-health.md)
- [Get images for a patient from Candid Health](https://docs.samplehc.com/api-reference/candid-health/get-images-for-a-patient-from-candid-health.md)
- [Update a patient in Candid Health](https://docs.samplehc.com/api-reference/candid-health/update-a-patient-in-candid-health.md): Updates a patient. The version parameter must be the next version number (current + 1) to prevent race conditions.
- [Calculate patient cost for a line item](https://docs.samplehc.com/api-reference/clearinghouse/calculate-patient-cost-for-a-line-item.md): Calculates the cost of a patient's services based on the provided information.
- [Cancel electronic claim](https://docs.samplehc.com/api-reference/clearinghouse/cancel-electronic-claim.md): Voids a previously submitted claim by submitting a new claim with claimFrequencyCode set to 8.
- [Check claim status](https://docs.samplehc.com/api-reference/clearinghouse/check-claim-status.md): Checks the real-time status of a claim using 276/277 transactions.
- [Check payer eligibility](https://docs.samplehc.com/api-reference/clearinghouse/check-payer-eligibility.md): Verifies patient eligibility with a specific payer for given services based on the provided patient and provider information.
- [Get claim status](https://docs.samplehc.com/api-reference/clearinghouse/get-claim-status.md): Retrieves the status and details of a submitted claim by its ID.
- [List payers](https://docs.samplehc.com/api-reference/clearinghouse/list-payers.md): Lists all payers available for eligibility checks.
- [Retrieve coordination of benefits (COB)](https://docs.samplehc.com/api-reference/clearinghouse/retrieve-coordination-of-benefits-cob.md): Fetches coordination of benefits (COB) information for a patient from a specified payer, detailing other insurance coverages.
- [Run discovery process](https://docs.samplehc.com/api-reference/clearinghouse/run-discovery-process.md): Initiates a discovery process to find insurance coverage for a patient using Front Runner integration.
- [Search payers](https://docs.samplehc.com/api-reference/clearinghouse/search-payers.md): Searches for payers based on the provided search criteria.
- [Submit electronic claim](https://docs.samplehc.com/api-reference/clearinghouse/submit-electronic-claim.md): 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.
- [Send a letter](https://docs.samplehc.com/api-reference/communication/send-a-letter.md): Sends a physical letter. The document must be a PDF file. Returns an ID for tracking.
- [Send email](https://docs.samplehc.com/api-reference/communication/send-email.md): 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 fax](https://docs.samplehc.com/api-reference/communication/send-fax.md): Initiates an asynchronous fax sending process. Returns an async result ID that can be used to track the status of the fax transmission.
- [Dashboard screen asset](https://docs.samplehc.com/api-reference/dashboard/dashboard-screen-asset.md): Retrieves a specific screen asset for a given dashboard. The asset path is specified by the wildcard part of the URL.
- [Execute SQL query](https://docs.samplehc.com/api-reference/database/execute-sql-query.md): Allows execution of arbitrary SQL queries against the Sample database. Supports parameterized queries with complex data types including arrays, objects, and nested structures. Examples: arrays can be used with ANY/ALL operators, objects as structs for complex filtering.
- [Classify document (async)](https://docs.samplehc.com/api-reference/document/classify-document-async.md): Initiates an asynchronous document classification process based on provided schemas. Returns an ID to track the async result.
- [Combine PDF documents](https://docs.samplehc.com/api-reference/document/combine-pdf-documents.md): Combines multiple PDF documents into a single PDF and returns the combined document's metadata.
- [Create documents from splits](https://docs.samplehc.com/api-reference/document/create-documents-from-splits.md): Creates new documents from specified page splits of an existing document.
- [Create PDF format from a Word document](https://docs.samplehc.com/api-reference/document/create-pdf-format-from-a-word-document.md): Converts an uploaded Word document (.doc, .docx) to a PDF file by creating a new PDF format representation. Returns the new PDF document's metadata.
- [Delete document](https://docs.samplehc.com/api-reference/document/delete-document.md): Deletes a document by its ID.
- [Document CSV content](https://docs.samplehc.com/api-reference/document/document-csv-content.md): Retrieves the content of a CSV document as a structured JSON array.
- [Document extraction (async)](https://docs.samplehc.com/api-reference/document/document-extraction-async.md): 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 metadata](https://docs.samplehc.com/api-reference/document/document-metadata.md): Retrieves metadata for a specific document, including a presigned URL for direct access if applicable.
- [Document reasoning (async)](https://docs.samplehc.com/api-reference/document/document-reasoning-async.md): Initiates an asynchronous document reasoning process based on a task. Returns an ID for tracking.
- [Full document details](https://docs.samplehc.com/api-reference/document/full-document-details.md): Retrieves comprehensive details for a specific document, including its content or OCR data if available, and a presigned URL.
- [Generate CSV document](https://docs.samplehc.com/api-reference/document/generate-csv-document.md): Creates a new CSV document from the provided rows of data and returns the new document's metadata.
- [Generate document from template (async)](https://docs.samplehc.com/api-reference/document/generate-document-from-template-async.md): 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.
- [Legacy split document (async)](https://docs.samplehc.com/api-reference/document/legacy-split-document-async.md): Initiates an asynchronous document splitting process. Returns an ID to track the async result.
- [PDF template document metadata](https://docs.samplehc.com/api-reference/document/pdf-template-document-metadata.md): Retrieves document metadata for a PDF template by slug, including a presigned URL for direct access.
- [Presigned URL for upload](https://docs.samplehc.com/api-reference/document/presigned-url-for-upload.md): Generates a presigned URL that can be used to directly upload a file to storage. Returns the URL and document metadata.
- [Render document body](https://docs.samplehc.com/api-reference/document/render-document-body.md): 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.
- [Search across documents](https://docs.samplehc.com/api-reference/document/search-across-documents.md): Performs a search query across a specified set of documents and returns matching results.
- [Split document (async)](https://docs.samplehc.com/api-reference/document/split-document-async.md): Initiates an asynchronous document splitting process. Returns an ID to track the async result.
- [Transform JSON to HTML](https://docs.samplehc.com/api-reference/document/transform-json-to-html.md): Transforms a Sample JSON document to HTML
- [Unzip file and return PDFs](https://docs.samplehc.com/api-reference/document/unzip-file-and-return-pdfs.md): 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 (async)](https://docs.samplehc.com/api-reference/document/unzip-file-and-return-pdfs-async.md): Given a document ID representing a ZIP file, unzip it, traverse the directory structure and return all PDFs found as a list of documents
- [Create event](https://docs.samplehc.com/api-reference/events/create-event.md)
- [Contribute document to HIE](https://docs.samplehc.com/api-reference/hie/contribute-document-to-hie.md): Contributes a document to the HIE network for a specific patient.
- [Query patient documents](https://docs.samplehc.com/api-reference/hie/query-patient-documents.md): Queries patient documents from the HIE network. Will reuse previously fetched data if a patient with the same external ID already exists in our records.
- [Subscribe to patient ADT feed](https://docs.samplehc.com/api-reference/hie/subscribe-to-patient-adt-feed.md): Creates or updates a patient and subscribes to their ADT (Admission, Discharge, Transfer) feed.
- [Get Careviso Payers](https://docs.samplehc.com/api-reference/integration--careviso/get-careviso-payers.md): Get a list of Careviso payers.
- [Submit Prior Authorization to Careviso](https://docs.samplehc.com/api-reference/integration--careviso/submit-prior-authorization-to-careviso.md): Submit a prior authorization request to Careviso.
- [Create Prior Authorization Draft](https://docs.samplehc.com/api-reference/integration--glidian/create-prior-authorization-draft.md): Create a draft prior authorization request in Glidian.
- [Get Clinical Questions for Prior Authorization Record](https://docs.samplehc.com/api-reference/integration--glidian/get-clinical-questions-for-prior-authorization-record.md): Retrieve clinical questions for a specific prior authorization record from Glidian.
- [Get Glidian Payers](https://docs.samplehc.com/api-reference/integration--glidian/get-glidian-payers.md): Get a list of available Glidian payers/insurances for a specific connection.
- [Get Glidian Services](https://docs.samplehc.com/api-reference/integration--glidian/get-glidian-services.md): Get a list of available Glidian services for a specific connection.
- [Get Glidian Submission Requirements](https://docs.samplehc.com/api-reference/integration--glidian/get-glidian-submission-requirements.md): Get submission requirements for a specific insurance and service combination.
- [Get Prior Authorization Record](https://docs.samplehc.com/api-reference/integration--glidian/get-prior-authorization-record.md): Retrieve a specific prior authorization record from Glidian.
- [Submit Prior Authorization](https://docs.samplehc.com/api-reference/integration--glidian/submit-prior-authorization.md): Submit a completed prior authorization to Glidian. All clinical questions must be answered first.
- [Update Clinical Questions](https://docs.samplehc.com/api-reference/integration--glidian/update-clinical-questions.md): Update clinical question responses for a Glidian prior authorization. May trigger additional questions.
- [Update Prior Authorization Record](https://docs.samplehc.com/api-reference/integration--glidian/update-prior-authorization-record.md): Update an existing prior authorization record in Glidian.
- [Get Kno2 attachment](https://docs.samplehc.com/api-reference/integration--kno2/get-kno2-attachment.md): Retrieve a specific attachment for a Kno2 message.
- [Get Kno2 message by ID](https://docs.samplehc.com/api-reference/integration--kno2/get-kno2-message-by-id.md): Retrieve a specific message for a Kno2 connection.
- [Create a new text note in OncoEMR](https://docs.samplehc.com/api-reference/integration--oncoemr/create-a-new-text-note-in-oncoemr.md): Creates a new text note in OncoEMR for a patient. The body can be plain text or HTML.
- [Find patient by MRN using connection slug](https://docs.samplehc.com/api-reference/integration--oncoemr/find-patient-by-mrn-using-connection-slug.md): Search for a patient by MRN using stored OncoEMR credentials.
- [Get complete order details from OncoEMR](https://docs.samplehc.com/api-reference/integration--oncoemr/get-complete-order-details-from-oncoemr.md): Fetches complete order details including options and timing information.
- [Update a radiology request in OncoEMR](https://docs.samplehc.com/api-reference/integration--oncoemr/update-a-radiology-request-in-oncoemr.md): Updates an existing radiology order in OncoEMR with the provided order data.
- [Run Salesforce CRUD action](https://docs.samplehc.com/api-reference/integration--salesforce/run-salesforce-crud-action.md): Resolve connection by slug and run a CRUD action on a Salesforce sObject.
- [Run Salesforce SOQL query](https://docs.samplehc.com/api-reference/integration--salesforce/run-salesforce-soql-query.md): Resolve connection by slug and run a SOQL query on Salesforce.
- [Query Snowflake](https://docs.samplehc.com/api-reference/integration--snowflake/query-snowflake.md): Execute a query against a configured Snowflake instance.
- [Add a patient to WellSky](https://docs.samplehc.com/api-reference/integration--wellsky/add-a-patient-to-wellsky.md): Add a patient to WellSky.
- [Create WellSky insurance](https://docs.samplehc.com/api-reference/integration--wellsky/create-wellsky-insurance.md): Create or update insurance information for a patient in WellSky.
- [Get WellSky insurances](https://docs.samplehc.com/api-reference/integration--wellsky/get-wellsky-insurances.md): Get all insurance records from WellSky.
- [Get WellSky patient types](https://docs.samplehc.com/api-reference/integration--wellsky/get-wellsky-patient-types.md): Get patient type options for a facility ID from WellSky.
- [Get WellSky programs](https://docs.samplehc.com/api-reference/integration--wellsky/get-wellsky-programs.md): Get programs from WellSky.
- [Get WellSky referral link sources](https://docs.samplehc.com/api-reference/integration--wellsky/get-wellsky-referral-link-sources.md): Get referral link sources (lookup table) from WellSky.
- [Get WellSky referral sources](https://docs.samplehc.com/api-reference/integration--wellsky/get-wellsky-referral-sources.md): Get referral sources from WellSky.
- [Get WellSky users](https://docs.samplehc.com/api-reference/integration--wellsky/get-wellsky-users.md): Get all users from WellSky EMR.
- [Search WellSky patients](https://docs.samplehc.com/api-reference/integration--wellsky/search-wellsky-patients.md): Search for patients in WellSky.
- [Make arbitrary xCures request](https://docs.samplehc.com/api-reference/integration--xcures/make-arbitrary-xcures-request.md): Make an arbitrary request to xCures using the configured connection identified by slug. Refer to https://partner.xcures.com/api-docs for the full API documentation.
- [Get companies](https://docs.samplehc.com/api-reference/policies/get-companies.md): Retrieve a list of companies.
- [Get plans](https://docs.samplehc.com/api-reference/policies/get-plans.md): Retrieve a list of plans.
- [Get policy text](https://docs.samplehc.com/api-reference/policies/get-policy-text.md): Retrieve the raw text content of a policy document.
- [Get presigned policy URL](https://docs.samplehc.com/api-reference/policies/get-presigned-policy-url.md): Retrieve a presigned URL for accessing a policy document.
- [Query policies](https://docs.samplehc.com/api-reference/policies/query-policies.md): Retrieve a list of policies based on specified filters.
- [List SSO directory groups](https://docs.samplehc.com/api-reference/sso/list-sso-directory-groups.md): Return all SSO directory groups configured for the authenticated organization.
- [List users for a SSO directory group](https://docs.samplehc.com/api-reference/sso/list-users-for-a-sso-directory-group.md)
- [Cancel task](https://docs.samplehc.com/api-reference/task/cancel-task.md): Marks a specified task as cancelled, preventing it from being executed. This also halts the execution of any subsequent tasks in the workflow.
- [Complete task](https://docs.samplehc.com/api-reference/task/complete-task.md): Marks a specified task as complete, providing the result of its execution. This may trigger the next task in the workflow.
- [Get task](https://docs.samplehc.com/api-reference/task/get-task.md): Retrieves the details of a task.
- [Get task state](https://docs.samplehc.com/api-reference/task/get-task-state.md): Retrieves the state of a task. This is typically used for tasks that need to persist state across multiple requests.
- [Retry task](https://docs.samplehc.com/api-reference/task/retry-task.md): Attempts to retry a failed task. This will re-queue the task for execution.
- [Suspended task payload](https://docs.samplehc.com/api-reference/task/suspended-task-payload.md): Retrieves the payload with which a task was suspended, typically for tasks awaiting external interaction or data.
- [Update task column](https://docs.samplehc.com/api-reference/task/update-task-column.md): Updates or inserts a column value for a task. If the column key already exists, its value will be updated. If it doesn't exist, a new column will be added.
- [Update task screen time](https://docs.samplehc.com/api-reference/task/update-task-screen-time.md): Adds a specified duration to the total screen time recorded for a task. This is typically used for tasks involving user interaction.
- [Update task state](https://docs.samplehc.com/api-reference/task/update-task-state.md): Updates the state of a task.
- [Execute SQL query](https://docs.samplehc.com/api-reference/v1/execute-sql-query.md): Allows execution of arbitrary SQL queries against the Sample database. Supports parameterized queries.
- [Query audit logs](https://docs.samplehc.com/api-reference/v1/query-audit-logs.md): Retrieves audit logs. Allows for filtering and searching through historical audit data.
- [Query workflow outputs](https://docs.samplehc.com/api-reference/v1/query-workflow-outputs.md): Queries outputs from a specific workflow run using a SQL-like language. Returns results as a JSON array.
- [Start workflow](https://docs.samplehc.com/api-reference/v1/start-workflow.md): Starts a workflow by its ID.
- [Cancel workflow run](https://docs.samplehc.com/api-reference/workflow-run/cancel-workflow-run.md): Requests cancellation of a currently active workflow run. This is an asynchronous operation and the run may take some time to fully stop.
- [Get apiv2workflow runscurrent task](https://docs.samplehc.com/api-reference/workflow-run/get-apiv2workflow-runscurrent-task.md)
- [Resume workflow after async task](https://docs.samplehc.com/api-reference/workflow-run/resume-workflow-after-async-task.md): Registers an asynchronous task's result ID to resume a workflow run upon its completion. This endpoint requires an ExecuteStepRequestContext with `workflowRunId` and `stepAddr`.
- [Step output](https://docs.samplehc.com/api-reference/workflow-run/step-output.md): Retrieves the output data of a specific step within a workflow run. This endpoint requires an ExecuteStepRequestContext with `workflowRunId` and `stepAddr`.
- [Workflow run details](https://docs.samplehc.com/api-reference/workflow-run/workflow-run-details.md): Retrieves the complete details of a specific workflow run by its ID.
- [Workflow run screen asset](https://docs.samplehc.com/api-reference/workflow-run/workflow-run-screen-asset.md): Retrieves a specific screen asset for a given workflow run. The asset path is specified by the wildcard part of the URL.
- [Workflow run start data](https://docs.samplehc.com/api-reference/workflow-run/workflow-run-start-data.md): Retrieves the initial data (startData) that was used to initiate the current workflow run. This endpoint requires an ExecuteStepRequestContext with a `workflowRunId`.
- [Deploy workflow](https://docs.samplehc.com/api-reference/workflow/deploy-workflow.md): Creates a new deployment for the specified workflow ID, making the current version of the workflow live.
- [Query workflow outputs](https://docs.samplehc.com/api-reference/workflow/query-workflow-outputs.md)
- [Start workflow by slug](https://docs.samplehc.com/api-reference/workflow/start-workflow-by-slug.md): Initiates a workflow run based on its slug. Accepts JSON or multipart/form-data for input.
- [Changelog](https://docs.samplehc.com/changelog.md): What's new with Sample
- [Authentication](https://docs.samplehc.com/guides/authentication.md): How to authenticate with the SampleHC API
- [Database](https://docs.samplehc.com/guides/database.md): Sample provides a fully managed, autoscaling PostgreSQL database powered by AWS for storing data between and across workflows.
- [Troubleshooting](https://docs.samplehc.com/guides/troubleshooting.md): Common troubleshooting steps and solutions for Sample Healthcare platform
- [Salesforce](https://docs.samplehc.com/integrations/salesforce.md): Learn how to connect your Salesforce account to Sample.
- [Intro to Screens](https://docs.samplehc.com/screens/index.md): Creating interactive user interfaces within workflows
- [Document Classification](https://docs.samplehc.com/screens/templates/document-classification.md): A screen template for classifying a document into a category
- [Document Splitting](https://docs.samplehc.com/screens/templates/document-splitting.md): A screen template for splitting a document into multiple pages
- [Document Upload](https://docs.samplehc.com/screens/templates/document-upload.md): A screen template for uploading a PDF document
- [Document Reasoning](https://docs.samplehc.com/screens/templates/legacy-document-reasoning.md): A screen template for document reasoning tasks and Q&A interactions
- [Document Viewer](https://docs.samplehc.com/screens/ui-components/document-viewer.md): Universal document viewer for PDFs and FHIR resources with search, highlighting, and citation support
- [Form Component](https://docs.samplehc.com/screens/ui-components/form.md): Advanced form builder with document upload, CSV processing, and validation
- [Introduction](https://docs.samplehc.com/screens/ui-components/index.md): Building screens with the SampleHC UI Library - a collection of React components built on shadcn/ui
- [Payer Search Combobox](https://docs.samplehc.com/screens/ui-components/payer-search.md): Searchable combobox for finding healthcare payers with autocomplete and alias support
- [PDF Viewer](https://docs.samplehc.com/screens/ui-components/pdf-viewer.md): Interactive PDF viewer with annotation and highlighting capabilities
- [Rich Text Editor](https://docs.samplehc.com/screens/ui-components/rich-text-editor.md): Tiptap-based rich text editor with healthcare-specific extensions and citation support
- [Column Values](https://docs.samplehc.com/workflows/column-values.md): Adding custom column displays to workflow steps
- [Workflow Context](https://docs.samplehc.com/workflows/context.md): Understanding the workflow context and how to access data between steps
- [Control Flow](https://docs.samplehc.com/workflows/control-flow.md): Learn how to structure workflow execution
- [Environment Variables](https://docs.samplehc.com/workflows/environment-variables.md): Managing environment variables in Sample Workflows
- [Events](https://docs.samplehc.com/workflows/events.md): Using events to trigger and control workflows
- [Introduction](https://docs.samplehc.com/workflows/index.md): What are Sample Workflows?
- [Quickstart](https://docs.samplehc.com/workflows/quickstart.md): How to develop and deploy workflows
- [Calling the Sample API](https://docs.samplehc.com/workflows/samplehc-api.md): Using the SampleHC API
- [Starting Workflows](https://docs.samplehc.com/workflows/start-workflow.md): How to start a workflow via API
- [Async Results](https://docs.samplehc.com/workflows/suspend-resume.md): Using suspend and resume to wait for async results
- [Workflows and Steps](https://docs.samplehc.com/workflows/workflows-and-steps.md): What are Sample Workflows?

## OpenAPI Specs

- [openapi.documented](https://app.stainless.com/api/spec/documented/samplehc/openapi.documented.yml)