R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #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 R3 R2

Extension: permitted-value-valueset

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : 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).

Comment :

The permitted value set must have a 1..1 set of codes for each code in the value meaning value set.

Context of Use: Use on Element ID StructureDefinition.snapshot.element.binding.valueSetCanonical, StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSetCanonical StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.options Questionnaire.item.answerValueSet

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension permitted-value-valueset 0..1 canonical ( ValueSet ) URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
permitted-value-valueset: 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 ID StructureDefinition.snapshot.element.binding.valueSetCanonical, StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSetCanonical StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.options Questionnaire.item.answerValueSet

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
permitted-value-valueset: 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 ID StructureDefinition.snapshot.element.binding.valueSetCanonical, StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSetCanonical StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.options Questionnaire.item.answerValueSet
... extension 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset"
. . . valueCanonical 0..1 canonical ( ValueSet ) Value of extension

doco Documentation for this format

XML Template 

<!-- permitted-value-valueset -->doco

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

JSON Template 

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

Summary

Name Flags Card. Type Description & Constraints doco
. . extension permitted-value-valueset 0..1 canonical ( ValueSet ) URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
permitted-value-valueset: 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 ID StructureDefinition.snapshot.element.binding.valueSetCanonical, StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSetCanonical StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.options Questionnaire.item.answerValueSet

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
permitted-value-valueset: 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 ID StructureDefinition.snapshot.element.binding.valueSetCanonical, StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSetCanonical StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.options Questionnaire.item.answerValueSet
... extension 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset"
. . . valueCanonical 0..1 canonical ( ValueSet ) Value of extension

doco Documentation for this format

XML Template 

<!-- permitted-value-valueset -->doco

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

JSON Template 

{ // permitted-value-valueset
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset", // 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')]) )