Your data

The data_* tools - the Data Sources index, owners, rate tables and CDMs, datasets, payers, fee-schedule imports, contracts, files, connectors and monitors.

These tools read and edit your team's Data Sources. Start with data_sections. Tools that delete, merge or switch a CDM's Latest version need confirm=true.

data_sections

Parameter	Type	Default	What it does

data_providers

Parameter	Type	Default	What it does

data_add_provider

Parameter	Type	Default	What it does
`ccn`	string	none	CMS Certification Number: the 6-digit id of a Medicare-certified hospital.
`city`	string	none
`msa`	string	none	The metro area (CBSA code) from find_metro: the market the chargemaster is benchmarked against.
`msa_name`	string	none	The metro area name, for display.
`name`	string	none	The study name.
`npi`	string	none
`state`	string	none	Two-letter US state, for example FL. A state on its own is not enough: add codes, apc, q or hospital_ids.

data_update_provider

Parameter	Type	Default	What it does
`city`	string	none
`health_system_id`	string	none
`msa`	string	none	The metro area (CBSA code) from find_metro: the market the chargemaster is benchmarked against.
`msa_name`	string	none	The metro area name, for display.
`name`	string	none	The study name.
`npi`	string	none
`provider_id`	string	required
`state`	string	none	Two-letter US state, for example FL. A state on its own is not enough: add codes, apc, q or hospital_ids.

data_remove_provider

Parameter	Type	Default	What it does
`confirm`	boolean	false
`provider_id`	string	required

data_create_health_system

Parameter	Type	Default	What it does
`msa`	string	none	The metro area (CBSA code) from find_metro: the market the chargemaster is benchmarked against.
`msa_name`	string	none	The metro area name, for display.
`name`	string	required	The study name.
`net_patient_revenue`	number	none

data_update_health_system

Parameter	Type	Default	What it does
`health_system_id`	string	required
`msa`	string	none	The metro area (CBSA code) from find_metro: the market the chargemaster is benchmarked against.
`msa_name`	string	none	The metro area name, for display.
`name`	string	none	The study name.
`net_patient_revenue`	number	none

data_delete_health_system

Parameter	Type	Default	What it does
`confirm`	boolean	false
`health_system_id`	string	required

data_provider

Parameter	Type	Default	What it does
`provider_id`	string	required

data_tables

Parameter	Type	Default	What it does
`kind`	rate \| cdm	rate	set_strategic_pricing_goal: max_revenue_within_market or revenue_neutral_optics. set_study_dataset: volume or cost. update_strategic_pricing_settings: the goal kind to switch to.
`owner`	string	none	The provider the rates belong to: a provider id or name in your account. A new name becomes a custom provider.

data_table_versions

Parameter	Type	Default	What it does
`kind`	rate \| cdm	required	set_strategic_pricing_goal: max_revenue_within_market or revenue_neutral_optics. set_study_dataset: volume or cost. update_strategic_pricing_settings: the goal kind to switch to.
`table_id`	string	required

data_effective_table

Parameter	Type	Default	What it does
`kind`	rate \| cdm	required	set_strategic_pricing_goal: max_revenue_within_market or revenue_neutral_optics. set_study_dataset: volume or cost. update_strategic_pricing_settings: the goal kind to switch to.
`provider`	string	required

data_set_latest

Parameter	Type	Default
`confirm`	boolean	false
`table_id`	string	required
`version_id`	string	required

data_export_table

Parameter	Type	Default	What it does
`kind`	rate \| cdm	required	set_strategic_pricing_goal: max_revenue_within_market or revenue_neutral_optics. set_study_dataset: volume or cost. update_strategic_pricing_settings: the goal kind to switch to.
`version_id`	string	required

data_rate_rows

Parameter	Type	Default	What it does
`cpt`	string	none
`limit`	integer	25	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.
`q`	string	none	Search the service description, up to 200 characters.
`version_id`	string	required

data_cdm_rows

Parameter	Type	Default	What it does
`cpt`	string	none
`department`	string	none
`limit`	integer	25	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.
`q`	string	none	Search the service description, up to 200 characters.
`rev_code`	string	none
`version_id`	string	required

data_fee_imports

Parameter	Type	Default	What it does
`owner`	string	none	The provider the rates belong to: a provider id or name in your account. A new name becomes a custom provider.

data_fee_import

Parameter	Type	Default	What it does
`import_id`	string	required

data_fee_import_crosscheck

Parameter	Type	Default	What it does
`import_id`	string	required
`limit`	integer	25	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.

data_fee_import_audit

Parameter	Type	Default	What it does
`import_id`	string	required

data_fee_import_uplift

Parameter	Type	Default	What it does
`import_id`	string	required

data_fee_import_events

Parameter	Type	Default	What it does
`cursor`	string	none
`import_id`	string	required
`limit`	integer	25	Most rows to return. Each tool has its own cap. On a free plan, paid data returns 8 rows whatever you ask for.

data_fee_import_binder

Parameter	Type	Default	What it does
`binder_id`	string	required
`import_id`	string	required

data_datasets

Parameter	Type	Default	What it does
`kind`	volume \| cost	none	set_strategic_pricing_goal: max_revenue_within_market or revenue_neutral_optics. set_study_dataset: volume or cost. update_strategic_pricing_settings: the goal kind to switch to.

data_dataset

Parameter	Type	Default	What it does
`dataset_id`	string	required	An existing volume or cost dataset in Data Sources; otherwise give upload_id and mapping.
`limit`	integer	25	Most rows to return. Each tool has its own cap. On a free plan, paid data returns 8 rows whatever you ask for.

data_dataset_rows

Parameter	Type	Default	What it does
`dataset_id`	string	required	An existing volume or cost dataset in Data Sources; otherwise give upload_id and mapping.
`dept`	string	none	A CDM department to narrow to.
`limit`	integer	25	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.
`period`	string	none
`q`	string	none	Search the service description, up to 200 characters.

data_add_dataset

Parameter	Type	Default	What it does
`description`	string	required	What the dataset holds and the study it is for; required for a new dataset.
`kind`	volume \| cost	required	set_strategic_pricing_goal: max_revenue_within_market or revenue_neutral_optics. set_study_dataset: volume or cost. update_strategic_pricing_settings: the goal kind to switch to.
`mapping`	object	required	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.
`name`	string	required	The study name.
`owner`	string	none	The provider the rates belong to: a provider id or name in your account. A new name becomes a custom provider.
`upload_id`	string	required	The id create_upload returned for the file.

data_update_dataset

Parameter	Type	Default	What it does
`dataset_id`	string	required	An existing volume or cost dataset in Data Sources; otherwise give upload_id and mapping.
`description`	string	none	What the dataset holds and the study it is for; required for a new dataset.
`name`	string	none	The study name.
`owner`	string	none	The provider the rates belong to: a provider id or name in your account. A new name becomes a custom provider.

data_delete_dataset

Parameter	Type	Default	What it does
`confirm`	boolean	false
`dataset_id`	string	required	An existing volume or cost dataset in Data Sources; otherwise give upload_id and mapping.

data_dataset_template

Parameter	Type	Default	What it does
`kind`	volume \| cost	volume	set_strategic_pricing_goal: max_revenue_within_market or revenue_neutral_optics. set_study_dataset: volume or cost. update_strategic_pricing_settings: the goal kind to switch to.

data_contracts

Parameter	Type	Default	What it does
`limit`	integer	25	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.
`owner`	string	none	The provider the rates belong to: a provider id or name in your account. A new name becomes a custom provider.

data_contract

Parameter	Type	Default	What it does
`contract_id`	string	required
`limit`	integer	25	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.

data_file_spaces

Parameter	Type	Default	What it does

data_file_space_file

Parameter	Type	Default	What it does
`chars`	integer	8000
`file_id`	string	required
`offset`	integer	0	Rows to skip, for paging.
`space_id`	string	required

data_payers

Parameter	Type	Default	What it does
`limit`	integer	25	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.
`q`	string	none	Search the service description, up to 200 characters.

data_unmapped_payers

Parameter	Type	Default	What it does
`limit`	integer	25	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.

data_master_payers

Parameter	Type	Default	What it does
`limit`	integer	25	Most rows to return. Each tool has its own cap. On a free plan, paid data returns 8 rows whatever you ask for.
`q`	string	none	Search the service description, up to 200 characters.

data_map_payer

Parameter	Type	Default	What it does
`core_payer_id`	string	required
`name`	string	required	The study name.

data_auto_map_payers

Parameter	Type	Default	What it does
`dry_run`	boolean	true

data_create_payer

Parameter	Type	Default	What it does
`aliases`	list of string	none
`core_payer_id`	string	none
`family`	string	none	Only this payer family.
`name`	string	required	The study name.
`notes`	string
`payer_class`	string	none

data_update_payer

Parameter	Type	Default	What it does
`aliases`	list of string	none
`core_payer_id`	string	none
`family`	string	none	Only this payer family.
`name`	string	none	The study name.
`notes`	string	none
`payer_class`	string	none
`payer_id`	string	required

data_merge_payers

Parameter	Type	Default
`confirm`	boolean	false
`into_payer_id`	string	required
`payer_id`	string	required

data_delete_payer

Parameter	Type	Default	What it does
`confirm`	boolean	false
`payer_id`	string	required

data_suggest_master_payer

Parameter	Type	Default	What it does
`carrier`	string	none
`name`	string	required	The study name.
`note`	string
`raw_names`	list of string	none

data_connectors

Parameter	Type	Default	What it does
`connector_id`	string	none
`limit`	integer	25	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.

data_monitors

Parameter	Type	Default	What it does

data_sectionsCopy Anchor Link

data_providersCopy Anchor Link

data_add_providerCopy Anchor Link

data_update_providerCopy Anchor Link

data_remove_providerCopy Anchor Link

data_create_health_systemCopy Anchor Link

data_update_health_systemCopy Anchor Link

data_delete_health_systemCopy Anchor Link

data_providerCopy Anchor Link

data_tablesCopy Anchor Link

data_table_versionsCopy Anchor Link

data_effective_tableCopy Anchor Link

data_set_latestCopy Anchor Link

data_export_tableCopy Anchor Link

data_rate_rowsCopy Anchor Link

data_cdm_rowsCopy Anchor Link

data_fee_importsCopy Anchor Link

data_fee_importCopy Anchor Link

data_fee_import_crosscheckCopy Anchor Link

data_fee_import_auditCopy Anchor Link

data_fee_import_upliftCopy Anchor Link

data_fee_import_eventsCopy Anchor Link

data_fee_import_binderCopy Anchor Link

data_datasetsCopy Anchor Link

data_datasetCopy Anchor Link

data_dataset_rowsCopy Anchor Link

data_add_datasetCopy Anchor Link

data_update_datasetCopy Anchor Link

data_delete_datasetCopy Anchor Link

data_dataset_templateCopy Anchor Link

data_contractsCopy Anchor Link

data_contractCopy Anchor Link

data_file_spacesCopy Anchor Link

data_file_space_fileCopy Anchor Link

data_payersCopy Anchor Link

data_unmapped_payersCopy Anchor Link

data_master_payersCopy Anchor Link

data_map_payerCopy Anchor Link

data_auto_map_payersCopy Anchor Link

data_create_payerCopy Anchor Link

data_update_payerCopy Anchor Link

data_merge_payersCopy Anchor Link

data_delete_payerCopy Anchor Link

data_suggest_master_payerCopy Anchor Link

data_connectorsCopy Anchor Link

data_monitorsCopy Anchor Link

On this page