JOjoincandidhealth
v1

Create Superbill

Changed on
post/api/superbill/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/superbill/v1
  • Auth
    HTTP bearer

Request body

patient_external_idstring required
date_range_minstring date required

Minimum (inclusive) date selected for the superbill

date_range_maxstring date required

Maximum (inclusive) date selected for the superbill

output_format'DOCX' | 'PDF'

Output format for the generated superbill.

include_merged_patient_databoolean

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

include_unfinalized_claim_financialsboolean

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

Response with status 200

Changes

  • d8b0a61873e2Revision changes
    • info

      added the new optional request property

  • 24b2d80d577aRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new DOCX enum value to the request property

    • info

      added the new PDF enum value to the request property

    • info

      added the required property to the response with the status