Create Superbill

Beta

POST

/api/superbill/v1

POST

/api/superbill/v1

curl -X POST https://api.joincandidhealth.com/api/superbill/v1 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "patient_external_id": "patient_external_id",
  "date_range_min": "2023-01-15",
  "date_range_max": "2023-01-15"
}'

{
  "superbills": [
    {
      "superbill_id": "superbill_id",
      "patient_external_id": "patient_external_id",
      "authed_url": "authed_url",
      "date_range_min": "2023-01-15",
      "date_range_max": "2023-01-15",
      "file_name": "file_name"
    },
    {
      "superbill_id": "superbill_id",
      "patient_external_id": "patient_external_id",
      "authed_url": "authed_url",
      "date_range_min": "2023-01-15",
      "date_range_max": "2023-01-15",
      "file_name": "file_name"
    }
  ]
}

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

patient_external_idstringRequired

Empty string not allowed

date_range_mindateRequired

Minimum (inclusive) date selected for the superbill

date_range_maxdateRequired

Maximum (inclusive) date selected for the superbill

pay_to_addressobjectOptional

Address that will be displayed on the superbill as the 'Pay to' Address. If not provided this value will be set from available encounter data.

output_formatenumOptional

Output format for the superbill. Defaults to DOCX if not specified.

Allowed values:

include_merged_patient_databooleanOptional

If true will include claims from any alternative patients the given patient_external_id has.

include_unfinalized_claim_financialsbooleanOptional

If true, adjustment, insurance paid, patient responsibility, and balance amounts are shown for claims that are not yet finalized, reflecting their current state. These amounts may change as remaining payers adjudicate. Defaults to false, which shows these amounts only for finalized claims.

Response

This endpoint returns an object.

superbillslist of objects

Each object represents a single Superbill for a single billing provider.

Errors

422

Unprocessable Entity Error