STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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 R3 R2

Extension: Permitted values

(No assigned work group) Maturity Level: 0Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset

Status: draft. Extension maintained by: Health Level Seven International (Orders and Observations)

Allows expressing the value set that must be stored internally by the system (as distinct from the base value set which defines values for exchange).

Context of Use: Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1Reference(ValueSet)URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
Permitted values: Allows expressing the value set that must be stored internally by the system (as distinct from the base value set which defines values for exchange).
Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options

doco Documentation for this format

Fulle Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
Permitted values: Allows expressing the value set that must be stored internally by the system (as distinct from the base value set which defines values for exchange).
Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset"
... valueReference 1..1Reference(ValueSet)Value of extension

doco Documentation for this format

XML Template

<!-- Permitted values -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset" >
  <!-- from Element: extension -->
 <valueReference><!-- 1..1 Reference(ValueSet) Value of extension --></valueReference>
</extension>

JSON Template

{ // Permitted values
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset", // R! 
    "valueReference" : { Reference(ValueSet) } // R! Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1Reference(ValueSet)URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
Permitted values: Allows expressing the value set that must be stored internally by the system (as distinct from the base value set which defines values for exchange).
Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
Permitted values: Allows expressing the value set that must be stored internally by the system (as distinct from the base value set which defines values for exchange).
Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset"
... valueReference 1..1Reference(ValueSet)Value of extension

doco Documentation for this format

XML Template

<!-- Permitted values -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset" >
  <!-- from Element: extension -->
 <valueReference><!-- 1..1 Reference(ValueSet) Value of extension --></valueReference>
</extension>

JSON Template

{ // Permitted values
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset", // R! 
    "valueReference" : { Reference(ValueSet) } // R! 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')]))