Skip Navigation Bar
NLM logo

VSAC Support Center

Retrieve Most Recent Value Set Expansions

Back to Main VSAC SVS API Page

URLs | Query Parameters | Sample Output

URLs with /RetrieveMultipleValueSets support the following use case:

  • Retrieve a value set expansion, including value set code list and metadata. The VSAC SVS API calculates this expansion using the most recent code systems in VSAC. This is not an appropriate call to use if you are trying to retrieve the correct expansion for a value set that is part of a published program release bound to specific code system versions. See Retrieve Value Set Expansions Published by a Program Release

URLs

The base URL is https://vsac.nlm.nih.gov/vsac/svs

Sample URL Description
https://vsac.nlm.nih.gov/vsac/svs/RetrieveMultipleValueSets?id=2.16.840.1.113883.3.117.1.7.1.226&ticket={ST} Retrieve the most recent value set expansion, includes value set expansion version, definition version, metadata and code list.
https://vsac.nlm.nih.gov/vsac/svs/RetrieveValueSet?id=2.16.840.1.113883.3.117.1.7.1.226&ticket={ST} Retrieve the most recent value set expansion, includes value set expansion version and code list, and no metadata or definition version.

Query Parameters

Parameter name Required? Y/N Description
ticket Y A single-use service ticket (ST) is required for each call to the VSAC SVS API.
id Y VSAC value set object identifier (OID)

Sample Output

Sample output for https://vsac.nlm.nih.gov/vsac/svs/RetrieveMultipleValueSets?id=2.16.840.1.113883.3.117.1.7.1.226&ticket={ST}

  • Value set definition version is the <RevisionDate> element.
  • Value set expansion version is the value of the version attribute within the <ns0:DescribedValueSet> element.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns0:RetrieveMultipleValueSetsResponse xmlns:ns0="urn:ihe:iti:svs:2008" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ns0:DescribedValueSet ID="2.16.840.1.113883.3.117.1.7.1.226" displayName="Thrombolytic (t-PA) Therapy" version="20190819">
        <ns0:ConceptList>
            <ns0:Concept code="1804799" codeSystem="2.16.840.1.113883.6.88" codeSystemName="RXNORM" codeSystemVersion="2019-08" displayName="alteplase 100 MG Injection"/>
            <ns0:Concept code="1804804" codeSystem="2.16.840.1.113883.6.88" codeSystemName="RXNORM" codeSystemVersion="2019-08" displayName="alteplase 50 MG Injection"/>
        </ns0:ConceptList>
        <ns0:Source>The Joint Commission</ns0:Source>
        <ns0:Purpose>(Clinical Focus: This value set contains concepts that represent medications that are prescribed for thrombolytic (t-PA) therapy for treatment of ischemic stroke.),(Data Element Scope: This value set may use the Quality Data Model (QDM) category related to Medication. The intent of this data element is to identify patients who are administered appropriate thrombolytic (t-PA) therapy for stroke.),(Inclusion Criteria: Includes only relevant concepts associated with RxNorm thrombolytic medications appropriate for stroke treatment consistent with administration by intravenous (IV) route.),(Exclusion Criteria: No exclusions.)</ns0:Purpose>
        <ns0:Type>Extensional</ns0:Type>
        <ns0:Binding>Dynamic</ns0:Binding>
        <ns0:Status>Active</ns0:Status>
        <ns0:RevisionDate>2017-07-27</ns0:RevisionDate>
    </ns0:DescribedValueSet>
</ns0:RetrieveMultipleValueSetsResponse>

Sample output for https://vsac.nlm.nih.gov/vsac/svs/RetrieveValueSet?id=2.16.840.1.113883.3.117.1.7.1.226&ticket={ST}


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns0:RetrieveValueSetResponse xmlns:ns0="urn:ihe:iti:svs:2008" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ns0:ValueSet ID="2.16.840.1.113883.3.117.1.7.1.226" displayName="Thrombolytic (t-PA) Therapy" version="20191216">
        <ns0:ConceptList>
            <ns0:Concept code="1804799" codeSystem="2.16.840.1.113883.6.88" codeSystemName="RXNORM" codeSystemVersion="2019-12" displayName="alteplase 100 MG Injection"/>
            <ns0:Concept code="1804804" codeSystem="2.16.840.1.113883.6.88" codeSystemName="RXNORM" codeSystemVersion="2019-12" displayName="alteplase 50 MG Injection"/>
        </ns0:ConceptList>
    </ns0:ValueSet>
</ns0:RetrieveValueSetResponse>

Last Reviewed: March 2, 2020