R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R3 R2

Extension: definition

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/valueset-definition

Status: draft. Extension maintained by: HL7

A display name that describes the meaning of this code when used as part of this value set.

Comment:

This is provided for when the source code system doesn't actually provide a definition (there are many such). Providing an definition for a code should not be done where the underlying code system provides a definition.

Context of Use: Use on Element ID ValueSet.compose.include.concept or Element ID ValueSet.expansion.contains

usage info: insert a list of places where this extension is used

Summary

Name	Flags	Card.	Type	Description & Constraints
definition		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/valueset-definition definition: A display name that describes the meaning of this code when used as part of this value set. Use on Element ID ValueSet.compose.include.concept or Element ID ValueSet.expansion.contains
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-definition definition: A display name that describes the meaning of this code when used as part of this value set. Use on Element ID ValueSet.compose.include.concept or Element ID ValueSet.expansion.contains
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-definition"
valueString	0..1	string	Value of extension
Documentation for this format

XML Template

<!-- definition -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-definition" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // definition
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-definition", // R! 
    "valueString" : "<string>" //Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
definition		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/valueset-definition definition: A display name that describes the meaning of this code when used as part of this value set. Use on Element ID ValueSet.compose.include.concept or Element ID ValueSet.expansion.contains
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-definition definition: A display name that describes the meaning of this code when used as part of this value set. Use on Element ID ValueSet.compose.include.concept or Element ID ValueSet.expansion.contains
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-definition"
valueString	0..1	string	Value of extension
Documentation for this format

XML Template

<!-- definition -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-definition" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // definition
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-definition", // R! 
    "valueString" : "<string>" //Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))