Black Box
The Black Box study tools - upload links, the build, one tool per results component, and the export.
These tools run a Black Box study end to end. They write to your account (a study, its datasets). blackbox_next_step and the next_step on every result walk the assistant through them.
blackbox_next_step
| Parameter | Type | Default | What it does |
|---|---|---|---|
study_id | string | none | The study id, as returned by the create tool or the list tool of that study kind. |
create_blackbox_study
| Parameter | Type | Default | What it does |
|---|---|---|---|
facility_name | string | required | |
health_system_name | string | none | |
name | string | none | The study name. |
network_filename | string | none | |
owner | string | required | The provider the rates belong to: a provider id or name in your account. A new name becomes a custom provider. |
provider_filename | string | provider-data.xlsx | |
study_id | string | none | The study id, as returned by the create tool or the list tool of that study kind. |
Returns the study and uploads: per file its role (provider_data, network_rates), what goes there, upload_id, curl and upload_page.
build_blackbox_study
| Parameter | Type | Default | What it does |
|---|---|---|---|
mapping | list of object | none | Which columns hold the code, the rates (one per payer) and the volume, per sheet: the suggested_mapping from inspect_upload, confirmed with the user. |
payer_map | object | none | |
study_id | string | required | The study id, as returned by the create tool or the list tool of that study kind. |
template | object | none | |
upload_id | string | required | The id create_upload returned for the file. |
list_blackbox_studies
| Parameter | Type | Default | What it does |
|---|
blackbox_sections
| Parameter | Type | Default | What it does |
|---|---|---|---|
study_id | string | required | The study id, as returned by the create tool or the list tool of that study kind. |
blackbox_by_cpt
| Parameter | Type | Default | What it does |
|---|---|---|---|
limit | integer | 200 | Most rows to return. Each tool has its own cap. On a free plan, paid data returns 8 rows whatever you ask for. |
offset | integer | 0 | Rows to skip, for paging. |
payer | string | none | Only this insurer, as named in the data. |
study_id | string | required | The study id, as returned by the create tool or the list tool of that study kind. |
The other components
Each takes study_id and limit and returns rows plus, where the component has them, totals, title, caption and text: blackbox_datasets, blackbox_summary_metrics, blackbox_by_payer, blackbox_by_category, blackbox_report_executive_summary, blackbox_report_materiality, blackbox_table1_current_by_cpt, blackbox_graph1_current_by_plan, blackbox_table2_projected_by_cpt, blackbox_graph2_projected_by_plan, blackbox_table3_change_by_cpt, blackbox_graph3_change_by_plan, blackbox_table4_percent_change_by_cpt, blackbox_graph4_percent_change_by_plan, blackbox_table5_by_category, blackbox_graph6_current_vs_projected_by_plan, blackbox_report_summary_observations, blackbox_report_background, blackbox_report_disclosures.
| Parameter | Type | Default | What it does |
|---|---|---|---|
limit | integer | 200 | Most rows to return. Each tool has its own cap. On a free plan, paid data returns 8 rows whatever you ask for. |
study_id | string | required | The study id, as returned by the create tool or the list tool of that study kind. |
export_blackbox
| Parameter | Type | Default | What it does |
|---|---|---|---|
format | string | Benchmark: xlsx, csv, sources or pdf. Strategic pricing: pdf, xlsx, proposal-csv, benchmarks-csv or mdc-crosswalk-csv. | |
study_id | string | required | The study id, as returned by the create tool or the list tool of that study kind. |
variant | string | full |