Superbill

Superbills can be uploaded by patients to their payers' portals to get reimbursed for out-of-network services.

The superbill model

Name
id
Type
string
Description
Unique identifier for the superbill.
Name
object
Type
string
Description
Always 'superbill'.
Name
name
Type
string
Description
Name of the superbill
Name
patient
Type
string
Description
Patient superbill is associated with.
Name
appointment
Type
string
Description
Appointment this superbill is associated. If there is no appointment this superbill is associated, leave this parameter blank.
Name
visit_note
Type
string
Description
Visit note this superbill is associated with. If there is no visit note this superbill is associated with, leave this parameter blank.
Name
rendering_provider
Type
string
Description
Provider that provided the medical services
Name
service_facility
Type
string
Description
Location a medical service was rendered, such as the provider office of hospital.
Name
billing_provider
Type
string
Description
Provider or business entity submitting the superbill and representing the person or entity being reimbursed.
Name
diagnoses
Type
array of objects
Description
Relevant diagnoses for superbill.
Name
billing_items
Type
array of objects
Description
Relevant billing items for superbill.
Name
comments
Type
array of strings
Description
Comments on this superbill.
Name
reviews
Type
array of objects
Description
Review history of the superbill.
Name
status_history
Type
array of objects
Description
Status history of the superbill.
Name
created_by
Type
string
Description
Creator of the superbill.
Name
created_at
Type
number
Description
Timestamp (in ISO 8601 format) of when the superbill was created.
Name
last_updated_at
Type
number
Description
Timestamp (in ISO 8601 format) of when this superbill was last updated.

Response

{
    "id": "sbll_02DCBCXf3BglWGW0eC3H",
    "object": "superbill",
    "name": "Mental Health Visit — May 10, 2023",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "appointment": "appt_iXijTmvKZayeKgLvUEUf",
    "visit_note": "note_JAgHSJHuSodCZ7IhTMqT",
    "rendering_provider": "user_idjkvxZTqfJD734feQHa",
    "service_facility": "sfac_tJFm1YU2tWDhpgUhXSZ5",
    "billing_provider": "bprv_9g36hEN5wgew2M59eIrF",
    "diagnoses": [
        {
            "diagnosis": "E11.9",
            "active": true,
            "onset_date": 1680000073000,
        }
    ],
    "billing_items": [
        {
            "date_of_service": 1684220126000,
            "procedure": "92012",
            "modifiers": [],
            "quantity": 1,
            "fee": 115,
            "associated_diagnoses": ["E11.9"],
            "paid": 110
        }
    ], 
    "comments": [
        "cmmt_18Efdm5UBJduDbioH1kp"
    ],
    "reviews": [
        {
            "status": "needs_review",
            "requested_by": "user_idjkvxZTqfJD734feQHa",
            "reviewer": "user_QtD0YaeDw4VyS9UPBpX4",
            "requested_at": 1684220332000,
            "review_deadline": 1686220332000,
            "reviewed_at": 1684220992000
        }
    ],
    "status_history": [
        {
            "status": "in_progress",
            "changed_by": "user_idjkvxZTqfJD734feQHa",
            "changed_at": 1653798303000
        },
        {
            "status": "submitted",
            "changed_by": "user_idjkvxZTqfJD734feQHa",
            "changed_at": 1684220992000
        }
    ],
    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}