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: R4B R4

Extension: supplement

Vocabulary Work Group Maturity Level: 1InformativeUse Context: Any

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 it's absence.

Context of Use: Use on Element ID ValueSet

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. supplement0..*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 it's absence.


Use on Element ID ValueSet

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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 it's absence.


Use on Element ID ValueSet
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-supplement"
... valueCanonical 0..1canonical(CodeSystem)Value of extension

doco Documentation for this format

XML Template

<!-- supplement -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-supplement" >
  <!-- from Element: extension -->
 <valueCanonical value="[canonical]"/><!-- 0..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>" //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. supplement0..*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 it's absence.


Use on Element ID ValueSet

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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 it's absence.


Use on Element ID ValueSet
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-supplement"
... valueCanonical 0..1canonical(CodeSystem)Value of extension

doco Documentation for this format

XML Template

<!-- supplement -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-supplement" >
  <!-- from Element: extension -->
 <valueCanonical value="[canonical]"/><!-- 0..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>" //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')]))