VSAC Utility API Calls: 'programs' and 'latest profile' for program
NLM developed utility calls as a method to retrieve metadata associated with value sets. These utility calls are not associated with the SVS API and do not adhere to the SVS specification. Utility calls require no authentication.
Utility calls using the program and programs parameters support the following use cases:
- Retrieve available values for programs that will enable you to then retrieve release name values for a program of interest.
- Retrieve all programs that have published a specified value set OID.
- Retrieve all release names for a specified value set OID published within a specified program so that you can use a specific release name to retrieve a correct expansion for a value set OID.
- Retrieve the latest profile label for your program so that you can then use your program's most recently developed expansion profile label to retrieve a correctly calculated expansion for your desired value set.
Related VSAC SVS API Endpoint Calls:
Query Parameters
| Parameter name | Required? Y/N | Description |
|---|---|---|
| program | Y | "Program" is the word VSAC applies to the administrative organization and/or application that sponsors, authors and stewards a published release of value sets that together serve a purpose. A program has a pre-arranged agreement with VSAC to publish their value sets as a group. |
| programs | Y | Retrieve all program name values for programs supported by VSAC. |
| latest profile | Y | The most recently available expansion profile to be used by a specified program |
Related Utility Calls
The base URL for VSAC utility calls is https://vsac.nlm.nih.gov/vsac/
| URL | Description |
|---|---|
| https://vsac.nlm.nih.gov/vsac/programs | Retrieve available program name values for programs supported by VSAC. For example: CMS eCQM and Hybrid Measure, CMS Pre-rulemaking, and HL7 C-CDA. Your retrieved program name values will enable you to then retrieve values for release names for releases a specific program has published. You can also use your retrieved program name values to then retrieve all published program release name values for a given value set OID. |
| https://vsac.nlm.nih.gov/vsac/program/{programName} | Retrieve all release names and releaseDates for a given program name. |
| https://vsac.nlm.nih.gov/vsac/oid/{oid}/programs | Retrieve all program names that have published the specified value set OID. |
| https://vsac.nlm.nih.gov/vsac/oid/{oid}/program/{programName} | Retrieve all published program releases (release names) for a given value set OID and programName. |
| https://vsac.nlm.nih.gov/vsac/program/{programName}/latest profile | Return the value of the most recently available expansion profile to be used by the specified program in an upcoming VSAC program release of that program's value set content. Value of latest profile is subject to change according to the goals of the program it represents. |
Sample Output
Sample output for https://vsac.nlm.nih.gov/vsac/programs (retrieved 05/20/2020)
{
"Program": [
{
"name": "CMS Hybrid",
"description": "The latest version of the CMS Hybrid Hospital-Wide Readmission measure, CMS529, is now located in the CMS eCQM and Hybrid Measure Value Sets."
},
{
"name": "CMS Pre-rulemaking eCQM",
"description": "CMS pre-rulemaking eCQMs include measures that are developed, but specifications are not finalized for reporting in a CMS program. The Pre-rulemaking eCQM value sets specify terminology codes for use in these pre-rulemaking eCQMs."
},
{
"name": "CMS eCQM and Hybrid Measure",
"description": "eCQMs use data from electronic health records (EHR) and/or health information technology systems to measure health care quality. eCQM value sets specify terminology codes required for eCQM measurement and are updated by CMS one or more times each year."
},
{
"name": "HL7 C-CDA",
"description": "Consolidated Clinical Document Architecture (C-CDA) value sets provide standardized terminology data elements for exchanging templated clinical information (e.g., Allergies, Encounters, Immunizations, Problems, Procedures, etc.) from electronic health records."
}
]
}
{
"name": "CMS eCQM and Hybrid Measure",
"description": "eCQMs use data from electronic health records (EHR) and/or health information technology systems to measure health care quality. eCQM value sets specify terminology codes required for eCQM measurement and are updated by CMS one or more times each year.",
"release": [
{
"name": "eCQM Update 2020-05-07",
"releaseDate": 20200507
},
{
"name": "eCQM Update 2019-05-10",
"releaseDate": 20190510
},
{
"name": "eCQM Update 2018-09-17",
"releaseDate": 20180917
},
{
"name": "eCQM Update 2018-05-04",
"releaseDate": 20180504
},
{
"name": "eCQM Update 2018 EP-EC and EH",
"releaseDate": 20170929
},
{
"name": "eCQM Update 4Q2017 EH",
"releaseDate": 20170915
},
{
"name": "eCQM Update 2017-05-05",
"releaseDate": 20170505
},
{
"name": "MU2 Update 2017-01-06",
"releaseDate": 20170106
},
{
"name": "MU2 Update 2016-04-01",
"releaseDate": 20160401
},
{
"name": "MU2 Update 2015-05-01",
"releaseDate": 20150501
},
{
"name": "MU2 EP Update 2014-07-01",
"releaseDate": 20140701
},
{
"name": "MU2 EP Update 2014-05-30",
"releaseDate": 20140530
},
{
"name": "MU2 EH Update 2014-04-01",
"releaseDate": 20140401
},
{
"name": "MU2 EP Update 2013-06-14",
"releaseDate": 20130614
},
{
"name": "MU2 EH Update 2013-04-01",
"releaseDate": 20130401
},
{
"name": "MU2 Update 2012-12-21",
"releaseDate": 20121221
},
{
"name": "MU2 Update 2012-10-25",
"releaseDate": 20121025
}
]
}
{
"Program": [
{
"name": "CMS eCQM and Hybrid Measure",
"description": "eCQMs use data from electronic health records (EHR) and/or health information technology systems to measure health care quality. eCQM value sets specify terminology codes required for eCQM measurement and are updated by CMS one or more times each year."
}
]
}
{
"name": "CMS eCQM and Hybrid Measure",
"description": "eCQMs use data from electronic health records (EHR) and/or health information technology systems to measure health care quality. eCQM value sets specify terminology codes required for eCQM measurement and are updated by CMS one or more times each year.",
"release": [
{
"name": "eCQM Update 2020-05-07",
"releaseDate": 20200507
},
{
"name": "eCQM Update 2019-05-10",
"releaseDate": 20190510
},
{
"name": "eCQM Update 2018-09-17",
"releaseDate": 20180917
},
{
"name": "eCQM Update 2018-05-04",
"releaseDate": 20180504
},
{
"name": "eCQM Update 2018 EP-EC and EH",
"releaseDate": 20170929
},
{
"name": "eCQM Update 4Q2017 EH",
"releaseDate": 20170915
},
{
"name": "eCQM Update 2017-05-05",
"releaseDate": 20170505
},
{
"name": "MU2 Update 2017-01-06",
"releaseDate": 20170106
},
{
"name": "MU2 Update 2016-04-01",
"releaseDate": 20160401
},
{
"name": "MU2 Update 2015-05-01",
"releaseDate": 20150501
},
{
"name": "MU2 EH Update 2014-04-01",
"releaseDate": 20140401
},
{
"name": "MU2 EH Update 2013-04-01",
"releaseDate": 20130401
},
{
"name": "MU2 Update 2012-12-21",
"releaseDate": 20121221
},
{
"name": "MU2 Update 2012-10-25",
"releaseDate": 20121025
}
]
}
{
"name": "eCQM Update 2020-05-07",
"requestTime": "2020-05-20 02:38:10 PM"
}
Last Reviewed: May 20, 2020