United States Health Information Knowledgebase

 

Meaningful Use API Documentation


Meaningful Use Value Sets

USHIK provides several means to retrieve Value Sets associated with Meaningful Use (Stage 2) measures. Several of these retrieval options conform to the IHE SVS (PDF) Exit Disclaimer [www.ihe.net] specification with several additional retrieval mechanisms, e.g.: retrieval of Value Sets by measure, also made available. Schema details for the SVS XML data types can be found on the ftp.ihe.net Exit Disclaimer [ftp.ihe.net] site. Access to Value Set data, including enumerated Concept lists, is limited to users and systems who have authenticated to USHIK using the UMLS authentication mechanism. Details about this authentication are included below.

USHIK provides resources to assist users in consuming the Meaningful Use Clinical Quality Measures published by CMS and the Value Sets published by the National Library of Medicine's Value Set Authority Center (VSAC) in support of the Meaningful Use incentive payment programs. The source of truth for these artifacts is CMS and NLM VSAC; users of USHIK are encouraged to consult these resources in conjunction with USHIK. Please contact the USHIK team if there are questions about the accuracy of any of these resources in USHIK.

CMS publishes the Meaningful Use Clinical Quality Measures at: http://cms.gov/Regulations-and-Guidance/Legislation/EHRIncentivePrograms/eCQM_Library.html
NLM VSAC publishes the Meaningful Use Value Sets at: http://vsac.nlm.nih.gov

Transaction: Retrieve Value Set

Use the SVS Transaction retrieveValueSet to retrieve a Value Set. This mechanism returns the enumerated ConceptList only by Value Set ID (OID). For a richer set of metadata, utilize the retrieveMultipleValueSets API transaction.

Purpose
Retrieve a single Multiple Meaningful Use Value Set by various methods.
Return Type
RetrieveValueSetResponse
Parameter Details:
Parameter Required Example Value Allowable Values Meaning
id Yes "2.16.840.1.113883.3.464.1003.104.12.1001" The OID of any Meaningful Use Value Set in USHIK Value Set Identifier (OID)
version No (defaults to show latest version) "20130401" The version number assigned to any Meaningful Use value set in USHIK. Value Set Version

Transaction: Retrieve Multiple Value Sets

Use the SVS Transaction retrieveMultipleValueSets to retrieve a Value Set or multiple Value Sets. This mechanism returns the enumerated ConceptList and additional supporting metadata describing the Value Set(s) and related Clinical Quality Measures.

Purpose
Retrieve Multiple Meaningful Use Value Sets by various methods.
Return Type
RetrieveMultipleValueSetsResponse
Parameter Details:
Parameter Required Example Value Allowable Values Meaning
id No "2.16.840.1.113883.3.464.1003.104.12.1001" The OID of any Meaningful Use Value Set in USHIK Value Set Identifier (OID)
MeasureId No "123" The ID of any Clinical Quality Measure in USHIK CMS Measure Identifier (e.g.: the "123" of CMS123v2)
NQFNumber No "0001" The NQF ID of any Clinical Quality Measure in USHIK Note: Not all CQMs have an assigned NQF ID
version No "3" (CQM) or "20130401" (value set) The version numbers assigned to any Meaningful Use value set or CQM in USHIK. The version number of the item identified, either a value sets or a CQM.
Parameter Notes
Calls to this API must specify a Value Set ID (id) OR Measure ID (MeasureId, NQFNumber). If a Measure identifier is presented, a (optional) version number can be specified; if not specified, the version number will default to "1".

Note: UMLS Authentication

The Meaningful Use Value Sets in USHIK have a requirement such that users or systems which access these Value Sets must first authenticate to the system using their UMLS credentials. (How to License and Access the Unified Medical Language System™ (UMLS™) Data). Authentication is handled in such a way that users or systems pass their respective UMLS credentials to USHIK and USHIK, in turn, passes these credentials to NLM to authenticate via their open authentication API.


Measure Retrieval Options

USHIK offers methods to retrieve the definitions of Clinical Quality Measures.

Transaction: Retrieve Measure XML (HQMF)

Retrieves the verbatim HQMF XML representation of a clinical quality measure as published by CMS. This XML contains only measure definition and components, not Value Set definitions or Concept Lists.

Purpose
Retrieve a single Multiple Meaningful Use Value Set by various methods.
Return Type
The representation of the specified measure in XML (HQMF format)
Parameter Details:
Parameter Required Example Value Allowable Values Meaning
format Yes "hqmf" "hqmf" Format of output
measureId No "102" The CMS ID of any Clinical Quality Measure in USHIK CMS Measure Identifier (e.g.: the "123" of CMS123v2)
nqfId No "0002" The NQF ID of any Clinical Quality Measure in USHIK. If specifying NQF ID, Version is also required Measure NQF ID
version No "1" "1", "2", or "3" (depending on the specific CQM) Measure Version

Transaction: Retrieve Measure Versions

Use the Transaction getMeasureVersions to retrieve all Measure Versions. This mechanism returns a MeasureList and supporting metadata describing the Measures.

Purpose
Retrieve all Measures Versions by various methods.
Return Type
RetrieveMeasureVersionRecordResponse
Parameter Details:
Parameter Required Example Value Allowable Values Meaning
measureId No "102" The ID of any Clinical Quality Measure in USHIK CMS Measure Identifier (e.g.: the "123" of CMS123v2)
eligibility No "EP" "EP", "EligibleProfessionals", "EH", or "EligibleHospitals" Measure Eligibility
Parameter Notes
No parameters needed to receive all measures. Use Measure Id (measureId) to get a specific measure. Use Eligibility (eligibility) to get Measures with a specific Eligibility.
Scroll To Top