Skip Navigation Bar
NLM logo

VSAC Support Center

Retrieve Value Set Expansion of a Draft Value Set Definition

Back to Main VSAC SVS API Page

URLs | Query Parameters | Related Utility Calls | Sample Output

URLs with /RetrieveMultipleValueSets using the includeDraft parameter support the following use case:

  • Retrieve a draft value set expansion using the specified expansion profile. Requires the profile parameter. The VSAC SVS API will allow draft value set retrieval only by the draft value set's assigned author or steward group members. The includeDraft parameter should only be used by value set authors or their proxies. VSAC does not guarantee that a draft will ever reach a published status which is required for use in external systems.

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.113762.1.4.1018.448&includeDraft=yes&profile=Most Recent Code System Versions in VSAC&ticket={ST} Retrieve a value set trial expansion of a draft value set definition using your specified expansion profile, includes value set code list, and metadata.

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)
includeDraft Y Allows retrieval of a non-published draft value set definition. Value is 'yes' or 'no'.
profile Y An expansion profile label that defines a calculation algorithm that applies predetermined code system versions and legacy codes. Examples: 'eCQM Update 2019-05-10', or 'Most Recent Code System Versions in VSAC'. The API defaults to 'Most Recent Code System Versions in VSAC' if the profile parameter is not specified.

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/profiles Return the list of available expansion profiles.

Sample Output

Sample output for https://vsac.nlm.nih.gov/vsac/svs/RetrieveMultipleValueSets?id=2.16.840.1.113762.1.4.1018.448&includeDraft=yes&profile=Most Recent Code System Versions in VSAC&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. When version="N/A" this means you have asked the VSAC SVS API to perform a temporary trial expansion/calculation of either a definition version or of a draft definition. A trial expansion does not exist in the public repository.

<?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.113762.1.4.1018.448" displayName="Congenital laryngeal anomalies" version="N/A">
        <ns0:ConceptList>
            <ns0:Concept code="1329005" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMEDCT" codeSystemVersion="2019-09" displayName="Division of congenital web of larynx (procedure)"/>
            <ns0:Concept code="204529000" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMEDCT" codeSystemVersion="2019-09" displayName="Congenital glottic web of larynx (disorder)"/>
            <ns0:Concept code="204530005" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMEDCT" codeSystemVersion="2019-09" displayName="Congenital subglottic web of larynx (disorder)"/>
            <ns0:Concept code="47070001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMEDCT" codeSystemVersion="2019-09" displayName="Congenital web of larynx (disorder)"/>
        </ns0:ConceptList>
        <ns0:Source>VSAC</ns0:Source>
        <ns0:Purpose>(Clinical Focus: ),(Data Element Scope: ),(Inclusion Criteria: Congenital and affecting the larynx.),(Exclusion Criteria: None)</ns0:Purpose>
        <ns0:Type>Extensional</ns0:Type>
        <ns0:Binding>Dynamic</ns0:Binding>
        <ns0:Status>Active</ns0:Status>
        <ns0:RevisionDate>2019-12-31</ns0:RevisionDate>
    </ns0:DescribedValueSet>
</ns0:RetrieveMultipleValueSetsResponse>

Last Reviewed: March 2, 2020