Skip to contents

Standardize a Query for an Endpoint

Source: R/query_standardize.R
standardize.Rd

Standardize a Query for an Endpoint

Usage

standardize(obj, qry)

Arguments

obj

An <endpoint>, <collection> or <group> object.

qry

A <query> object.

Value

A list of query parameters matched to an endpoint's fields.

Examples

standardize(
  endpoint("drug_state"),
  query(year = 2022:2024,
  state = any_of("GA", "NY")))
#> $idx
#> [1] 1 2 3
#> 
#> $year
#> [1] 2024 2023 2022
#> 
#> $id
#> [1] "https://data.medicaid.gov/api/1/datastore/query/61729e5a-7aa8-448c-8903-ba3e0cd0ea3c/0"
#> [2] "https://data.medicaid.gov/api/1/datastore/query/d890d3a9-6b00-43fd-8b31-fcba4c8e2909/0"
#> [3] "https://data.medicaid.gov/api/1/datastore/query/200c2cba-e58d-4a95-aa60-14b99736808d/0"
#> 
#> $field
#> $field$`2024`
#> $field$`2024`$state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "GA" "NY"
#>  @ member_of: chr(0) 
#> 
#> 
#> $field$`2023`
#> $field$`2023`$state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "GA" "NY"
#>  @ member_of: chr(0) 
#> 
#> 
#> $field$`2022`
#> $field$`2022`$state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "GA" "NY"
#>  @ member_of: chr(0) 
#> 
#> 
#> 

standardize(
  endpoint("enroll_prov"),
  query(enrlmt_id = "I20040309000221"))
#> $ENRLMT_ID
#> [1] "I20040309000221"
#> 

standardize(
  collection("dialysis"),
  query(state = "AL"))
#> $dial_listing
#> $dial_listing$state
#> [1] "AL"
#> 
#> 
#> $dial_nation
#> named list()
#> 
#> $dial_state
#> $dial_state$state
#> [1] "AL"
#> 
#> 

standardize(
  endpoint("dial_facility"),
  query(
    state = "GA",
    city = "Atlanta",
    provcity = "Atlanta",
    provider_name = starts_with("C"),
    provname = starts_with("C")
  )
)
#> $idx
#> [1] 1 2 3 4 5 6
#> 
#> $year
#> [1] 2025 2024 2023 2022 2021 2020
#> 
#> $id
#> [1] "https://data.cms.gov/data-api/v1/dataset/7d4e7bd1-f08a-4fca-8085-6af24026a19a/data"
#> [2] "https://data.cms.gov/data-api/v1/dataset/62d125ff-c959-4c5c-8a46-8cacba50bfd4/data"
#> [3] "https://data.cms.gov/data-api/v1/dataset/200e7e7e-a5a6-4450-ba18-ab53d237cc45/data"
#> [4] "https://data.cms.gov/data-api/v1/dataset/ebc64ad1-164c-455a-80ca-cb0753e44a46/data"
#> [5] "https://data.cms.gov/data-api/v1/dataset/e66eaf03-398f-4a8c-9d1b-6aaf25fb6425/data"
#> [6] "https://data.cms.gov/data-api/v1/dataset/44aedde0-c535-497d-ab27-b415ec12ff5a/data"
#> 
#> $field
#> $field$`2025`
#> $field$`2025`$state
#> [1] "GA"
#> 
#> $field$`2025`$Provider_Name
#> <starts_with>
#>  @ operator : chr "STARTS_WITH"
#>  @ value    : chr "C"
#>  @ member_of: chr(0) 
#> 
#> $field$`2025`$city
#> [1] "Atlanta"
#> 
#> 
#> $field$`2024`
#> $field$`2024`$state
#> [1] "GA"
#> 
#> $field$`2024`$Provider_Name
#> <starts_with>
#>  @ operator : chr "STARTS_WITH"
#>  @ value    : chr "C"
#>  @ member_of: chr(0) 
#> 
#> $field$`2024`$city
#> [1] "Atlanta"
#> 
#> 
#> $field$`2023`
#> $field$`2023`$state
#> [1] "GA"
#> 
#> $field$`2023`$Provider_Name
#> <starts_with>
#>  @ operator : chr "STARTS_WITH"
#>  @ value    : chr "C"
#>  @ member_of: chr(0) 
#> 
#> $field$`2023`$city
#> [1] "Atlanta"
#> 
#> 
#> $field$`2022`
#> $field$`2022`$state
#> [1] "GA"
#> 
#> $field$`2022`$Provider_Name
#> <starts_with>
#>  @ operator : chr "STARTS_WITH"
#>  @ value    : chr "C"
#>  @ member_of: chr(0) 
#> 
#> $field$`2022`$city
#> [1] "Atlanta"
#> 
#> 
#> $field$`2021`
#> $field$`2021`$State
#> [1] "GA"
#> 
#> $field$`2021`$`Provider Name`
#> <starts_with>
#>  @ operator : chr "STARTS_WITH"
#>  @ value    : chr "C"
#>  @ member_of: chr(0) 
#> 
#> $field$`2021`$City
#> [1] "Atlanta"
#> 
#> 
#> $field$`2020`
#> $field$`2020`$state
#> [1] "GA"
#> 
#> $field$`2020`$provname
#> <starts_with>
#>  @ operator : chr "STARTS_WITH"
#>  @ value    : chr "C"
#>  @ member_of: chr(0) 
#> 
#> $field$`2020`$provcity
#> [1] "Atlanta"
#> 
#> 
#> 

standardize(
  endpoint("qppe"),
  query(
    year = 2021:2023,
    practice_state_or_us_territory = any_of("GA", "FL"),
    practice_size = less_than(10, or_equal = TRUE)
  )
)
#> $idx
#> [1] 1 2 3
#> 
#> $year
#> [1] 2023 2022 2021
#> 
#> $id
#> [1] "https://data.cms.gov/data-api/v1/dataset/3545dc8e-7037-41ee-8a1d-9f3198fe4927/data"
#> [2] "https://data.cms.gov/data-api/v1/dataset/b3438273-b4a6-44ca-8fb2-9e6026b74642/data"
#> [3] "https://data.cms.gov/data-api/v1/dataset/8c2ab3e4-597e-43c9-9d94-7223c66d7f25/data"
#> 
#> $field
#> $field$`2023`
#> $field$`2023`$`practice state or us territory`
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "GA" "FL"
#>  @ member_of: chr(0) 
#> 
#> $field$`2023`$`practice size`
#> <less_than>
#>  @ operator : chr "<="
#>  @ value    : num 10
#>  @ member_of: chr(0) 
#> 
#> 
#> $field$`2022`
#> $field$`2022`$`practice state or us territory`
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "GA" "FL"
#>  @ member_of: chr(0) 
#> 
#> $field$`2022`$`practice size`
#> <less_than>
#>  @ operator : chr "<="
#>  @ value    : num 10
#>  @ member_of: chr(0) 
#> 
#> 
#> $field$`2021`
#> $field$`2021`$`practice state or us territory`
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "GA" "FL"
#>  @ member_of: chr(0) 
#> 
#> $field$`2021`$`practice size`
#> <less_than>
#>  @ operator : chr "<="
#>  @ value    : num 10
#>  @ member_of: chr(0) 
#> 
#> 
#> 

standardize(
  endpoint("hc_quality"),
  query(state = any_of("Georgia", "Alabama"), year = 2020:2023))
#> $idx
#> [1] 2 3 4 5
#> 
#> $year
#> [1] 2023 2022 2021 2020
#> 
#> $id
#> [1] "https://data.medicaid.gov/api/1/datastore/query/e85033c7-367e-467e-9e81-8e85048102b8/0"
#> [2] "https://data.medicaid.gov/api/1/datastore/query/dfd13757-d763-4f7a-9641-3f06ce21b4c6/0"
#> [3] "https://data.medicaid.gov/api/1/datastore/query/a058ef78-e18b-4435-94aa-b70ab6ce5904/0"
#> [4] "https://data.medicaid.gov/api/1/datastore/query/fbbe1734-b448-4e5a-bc94-3f8688534741/0"
#> 
#> $field
#> $field$`2023`
#> $field$`2023`$state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "Georgia" "Alabama"
#>  @ member_of: chr(0) 
#> 
#> 
#> $field$`2022`
#> $field$`2022`$state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "Georgia" "Alabama"
#>  @ member_of: chr(0) 
#> 
#> 
#> $field$`2021`
#> $field$`2021`$state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "Georgia" "Alabama"
#>  @ member_of: chr(0) 
#> 
#> 
#> $field$`2020`
#> $field$`2020`$state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:2] "Georgia" "Alabama"
#>  @ member_of: chr(0) 
#> 
#> 
#> 

standardize(
  endpoint("pdc_clinician"),
  query(
    provider_first_name = starts_with("An"),
    provider_last_name = contains("JE"),
    state = any_of("CA", "GA", "NY")))
#> $provider_last_name
#> <contains>
#>  @ operator : chr "CONTAINS"
#>  @ value    : chr "JE"
#>  @ member_of: chr(0) 
#> 
#> $provider_first_name
#> <starts_with>
#>  @ operator : chr "STARTS_WITH"
#>  @ value    : chr "An"
#>  @ member_of: chr(0) 
#> 
#> $state
#> <any_of>
#>  @ operator : chr "IN"
#>  @ value    : chr [1:3] "CA" "GA" "NY"
#>  @ member_of: chr(0) 
#>