This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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: R4B R4

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: supplement

URL for this extension:

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

Status: draft. Extension maintained by: HL7

This extension declares that a value set depends on a particular supplement and should not be used in its absence.

Context of Use: Use on Element ID ValueSet

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
supplement		0..*	canonical(CodeSystem)	URL = http://hl7.org/fhir/StructureDefinition/valueset-supplement supplement: This extension declares that a value set depends on a particular supplement and should not be used in its absence. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-supplement supplement: This extension declares that a value set depends on a particular supplement and should not be used in its absence. Use on Element ID ValueSet
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-supplement"
value[x]		1..1	canonical(CodeSystem)	Value of extension
Documentation for this format

XML Template

<!-- supplement -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-supplement" >
  <!-- from Element: extension -->
 <valueCanonical value="[canonical]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
supplement		0..*	canonical(CodeSystem)	URL = http://hl7.org/fhir/StructureDefinition/valueset-supplement supplement: This extension declares that a value set depends on a particular supplement and should not be used in its absence. Use on Element ID ValueSet
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-supplement supplement: This extension declares that a value set depends on a particular supplement and should not be used in its absence. Use on Element ID ValueSet
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-supplement"
value[x]		1..1	canonical(CodeSystem)	Value of extension
Documentation for this format

XML Template

<!-- supplement -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-supplement" >
  <!-- from Element: extension -->
 <valueCanonical value="[canonical]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

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

Constraints

• ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
• ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)