Skip to main content

Part of Authoring FHIR terminology resources

How to create a new value set

Before you start

You will need to be able to log in as an author to add a new FHIR resource. Refer to the getting started section for more information.  

You may also find it useful to to watch a tour of the system's code system capability. You can do this by clicking on the code system tour button which appears in the middle of the screen.  

screen shot of Snapper Author with code system tour highlighted.


Create a new FHIR value set

To create a new value set, you need to have at least one code system to provide codes for your value set loaded into your FHIR server. They can be local, standardised, or proprietary

1. Click the Plus sign on the left-hand side of the screen next to the FHIR value set. 

Snapper author screen with value set tour highlighted


2. In the pop up screen, fill up your metadata and click Done

To learn more about metadata read the FHIR metadata resource value set.

3. You can include or exclude codes to the value set by specifying specific codes or by using filters. 

Snapper author screen with FIHR value set image

 


To create a new include or exclude parameter, use the include codes, exclude codes, include filters, or exclude filters

Create a new include or exclude parameter screen.

You will need to create a new parameter for each code system if you want to take codes from multiple code systems. 

Snapper screen shot with code system highlighted


To include codes or exclude codes you can manually enter the codes one by one in the table at the bottom of the screen to record the code and display.

Snapper value set with code display screen highlighted.

 


Or search the code system using the search bar on the right. 

Once you find the code you are looking for, you can drag the code from the results into the table at the bottom of the screen.

snapper screen displaying sample value set and code system search highlighted


You can import codes from a csv or tsv by clicking the import codes from file (csv/tsv).

A wizard will pop up to walk you through browsing for your file and select the file type, number of header rows, and the columns to be imported

Sample value set screen with import codes from file highlighted

To import or export filters, fill in the code system and the details of your filter. 


4.You can add any additional metadata you have in the additional metadata tab.

Import codes from file screen with select the type of file CSV or TSV displayed

 

 


5. In the upload to FHIR server tab, you can:

  • validate your value set
  • download your definition or expansion of the value set 
  • upload your value set 
  • syndicate your value set (You will need to have approver permission to do this.)

Last edited: 4 January 2024 1:52 pm