HL7 FHIR® UK Core Design and Development Approach

ValueSet Descriptions

A free text natural language description of the of the ValueSet from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the ValueSet Expansion, and also may specify the intended use and limitations of the ValueSet. In the UK Core there is a preference to use the words "define" or "describe" and more rarely, "identify".

The prefix SHOULD be as follows:

A set of codes that define [description].



For SNOMED CT and dm+d concepts, the following SHOULD be added after the prefix:

  • For a ValueSet containing a set of SNOMED CT Reference Sets and/or hierarchies and/or individual concepts:
Selected from the following SNOMED CT UK coding system: \n 
- [long syntax1] [RefSet/hierarchy1 code] | [description of RefSet/hierarchy1] \n
- [long syntax2] [RefSet/hierarchy2 code] | [description of RefSet/hierarchy2] \n,  etc. 

  • Where the ValueSet include dm+d concept classes:
Selected from the following dm+d (dictionary of medicines and devices) concept classes:\n
[concept1] | [description1] \n
[concept2] | [description2] \n, etc.



Where the ValueSet includes nullFlavor(s) in addition to other sets of codes, the suffix SHOULD be as the following:

Where no [MainCodeSystems] coded information is available, a specific code from the nullFlavor CodeSystem can be used instead to indicate this.

For complicated descriptions, particularly where a complex set of SNOMED references is used, and where inclusion of a carriage return / line feed can make the content more presentable in Simplifier, the sequence can be inserted to start a new line and can be inserted to leave a line break before the next line starts. For examples see Example ValueSets from the UK Core section.


back to top