updateAffiliation
Query to update health system and provider affiliations given provider/system parameters given.
Health system provider affiliations, provider directories, and the reality/expectations/contradictions surrounding those relationships can be complicated - furthermore, it can hard to get perfectly right from an outside perspective.
Though affiliationActivity serves as the central tool in working with provider affiliation within CareQuery, we developed the updateAffiliation functionality to give users the ability to update provider lists affiliated specified health systems.
Affiliation updates will be reflected immediately for the user, and their changes will also be submitted for review before being reflected across all CareQuery users.
Get Started with updateAffiliation
If you have already setup CareQuery, run the below code to get started with your first updateAffiliation query.
Add Providers
On occasions where you know certain provider(s) are affiliated with a health system, but do not see them within CareQuery recorded as such, you may run the following function to submit an update to the underlying dataset.
Add to Health System list of Affiliated Providers
# import package
from care_query.care_query import CareQuery
# instantiate and connect
cq = CareQuery(email = "your-email",
token = "your-api-token")
# construct affiliation update
update = cq.updateAffiliation(system = "hca healthcare",
add_npis = [1003000126,1003004706,1003006222])
# execute affiliation update
update.execute()
Remove Providers
On occasions where you know certain provider(s) are NOT affiliated with a health system, but see them with CareQuery recorded as such, you may run the following function to submit an update to the underlying dataset.
Remove Providers from Health System List of Affiliated Providers
# import dependencies
from care_query import CareQuery
# connect to CareQuery
cq = CareQuery(token = "xxxxxxxxxxxxxxxxxxxxx")
# construct affiliation update
update = cq.updateAffiliation(system = "hca healthcare",
remove_npis = [1003000126,1003004706,1003006222])
# execute affiliation update
update.execute()
Query Parameters
The following a parameters are available within the updateAffiliation query, including details on the parameter values.
| parameter | description | options |
|---|---|---|
system | Name of the system an individual provider may be affiliated with in any way - either indicated by overall affiliation, or via the system affiliation for any of the top 3 healthcare organization (hco) in which they practice at | values available |
add_npi | National Provider Identifier (NPI) an individual and/or organizational provider(s) with which you would like to ADD to the affiliation list of the system specified. | Any Valid NPI |
remove_npi | National Provider Identifier (NPI) an individual and/or organizational provider(s) with which you would like to REMOVE from the affiliation list of the system specified. | Any Valid NPI |
show | Binary indicator as to whether you'd like query to be printed for review upon it's creation | True or False |
Query Return Data
The updateAffiliation query does not return data, but rather updates the AFFILIATION_TABLE NPIs that meet the criterion specified within the query.
Advanced Query Logic & Recipes
updateAffiliation does not return data, but simply allows users to update the reported affiliation data, thus it does not return data upon execution.
Updated about 1 year ago