R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 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 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).

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

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

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Reference(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: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, Questionnaire.item.options
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
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: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, Questionnaire.item.options
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset"
valueReference	0..1	Reference(ValueSet)	Value of extension
Documentation for this format

XML Template

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

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset" >
  <!-- from Element: extension -->
 <valueReference><!-- 0..1 Reference(ValueSet) Value of extension --></valueReference>
</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! 
    "valueReference" : { Reference(ValueSet) } //Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Reference(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: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, Questionnaire.item.options
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
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: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, Questionnaire.item.options
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset"
valueReference	0..1	Reference(ValueSet)	Value of extension
Documentation for this format

XML Template

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

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset" >
  <!-- from Element: extension -->
 <valueReference><!-- 0..1 Reference(ValueSet) Value of extension --></valueReference>
</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! 
    "valueReference" : { Reference(ValueSet) } //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')]))