- What does this mean?
- What will happen?
- How to do this
- Where are my value set’s previous published extensional definition versions?
- Are my converted value set’s published expansions of extensional definitions still accessible for public search/retrieval/usage?
What does this mean?
If you can logically define your existing enumerated extensional value set, we encourage you to convert its definition method to “intensional” so that you can create rule-based clauses to more accurately define and efficiently maintain your value set.
The Convert-to-Intensional function allows you to redefine your extensional value set using rule-based logic. Your value set will retain the same value set object identifier (OID), which is critical when other applications may already be referencing its OID. Find more information about Intensional Value Sets.
What will happen?
‘Convert-to-Intensional’ is not reversible. You can redefine an existing extensional value set as an intensionally defined value set, but you cannot redefine an intensional value set as an extensionally defined value set.
Convert-to-Intensional will:
- Retain the same value set object identifier (OID) and metadata.
- Reconfigure your value set’s definition user interface to allow you to create logical clauses.
- Delete any existing draft extensional definition for your value set and preserve the draft in the Extensional Definition Archive. If you want to keep your draft extensional definition, publish your draft before conversion. See Expand/Publish Value Set.
- Provide a spreadsheet (Extensional Definition Archive) for you to access all previously published and draft extensional definitions.
- Retain public access to all published expansions of extensional value set definitions in the Search Value Sets public browser, downloads and API.
- Return you to My Value Set Definitions after conversion. Click on your value set’s OID to access its new intensional definition and define your logical clauses.
Convert-to-Intensional will NOT:
- Will not convert grouping value sets to intensional. Instead, you need to convert each extensional member value set to intensional, and then your grouping value set expansion will be based on the intensionally redefined member value sets
- Will not convert your existing extensional code list into logical clauses for you. You must create intensional clauses yourself.
How to do this
Convert-to-Intensional
- Go to the Authoring tab, find your value set, and open it. The value set will appear in its own tab.
- Click Convert to Intensional in the left side bar.
- Read the Confirmation message and click OK or Cancel.
Define your value set using logical clauses
After the conversion, VSAC returns you to your My Value Set Definitions table
- Click on the OID of your converted value set, which is now labeled as Intensional.
- Review your value set’s Metadata and revise it if you desire.
- Review your previous extensional definitions for your value set in the left side bar: Extensional Definition Archive.
- Create your logical clauses in the Definition tab. See Create an Intensional Value Set documentation and on-screen help.
Tips for creating your logical clauses
- Use enumerated code lists from your archived definitions, located in the Extensional Definition Archive.
- Copy your desired codes and import them into your new intensional definition’s Code Clipboard.
- Study VSAC’s Browse Code Systems to understand the structure of your code system and the codes you need for logical clauses.
Where are my value set’s previous published extensional definition versions?
- Your published and draft extensionally defined versions of your value set are still here for you, but they have moved out of the definition version drop down menu of the Authoring → Definition user interface.
- You can find all of your published and draft extensional definition value sets in the left side bar, in the Extensional Definition Archive.
- When you select the Extensional Definition Archive, you will download a spreadsheet containing the metadata and enumerated codes of every extensional value set definition you have published for that value set.
- You may find it helpful to use your extensional definition archive spreadsheet as a tool: copy and import selected codes into your Code Clipboard, as a method to recreate your value set intensionally with logical clauses.
Are my converted value set’s published expansions of extensional definitions still accessible for public search/retrieval/usage?
- Yes, as long as you expanded/published your definition through the Expansion/Publication tab of the Authoring Tool, or through a Program Release (e.g., CMS eCQM, C-CDA) before you converted your value set definition method to intensional.
- To ensure persistence of the expansion of any definition version of your value set, use the Expand/Publish feature in the Authoring Tool. Expand/Publish generates a published expansion version of your value set that will always persist in the public Search Value Sets browser and will always be retrievable by the SVS API using the expansion version (version parameter).
- When you created your extensionally defined value set, if you clicked Approve, you triggered an automatic sample snapshot expansion called “Latest” in the Search Value Sets public user interface. VSAC will display this sample snapshot “Latest” expansion in the public repository Search Value Sets until it is replaced by your new expansion based on your new intensionally defined version, once you approve it.
Not available, but under development for early 2020:
- FHIR API retrieval of expansions of previously published definition versions
- FHIR API retrieval of expansions of intensional definitions
Last Reviewed: May 14, 2019