Snapshot 3: Connectathon 32 Base

This is Snapshot #3 for FHIR R5, released to support Connectathon 32. For a full list of available versions, see the Directory of published versions.

Extension: maxValueSet

FHIR Infrastructure Work Group Maturity Level: 1Trial UseUse Context: Any
Official URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet Version: 5.0.0-snapshot3
draft as of 2015-02-28 Computable Name: maxValueSet
Flags: Non-Modifier OID: TBD

Context of Use: Use on Element ID ElementDefinition.binding

Definition

This acts as an overall 'required' binding for an element that already has a less restrictive binding. It is used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set that the codes must be drawn from is 'infinite'. The the base less restrictive binding SHALL be a proper subset of the max binding valueset. In most cases, this extension is used where the base binding is 'extensible'.

Comment:

Typically, this will be an entire code system, e.g. SNOMED CT. The maximum binding needs to include all the codes in the extensible or preferred binding.

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. maxValueSet0..1uri, canonical(ValueSet)URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: This acts as an overall 'required' binding for an element that already has a less restrictive binding. It is used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set that the codes must be drawn from is 'infinite'. The the base less restrictive binding SHALL be a proper subset of the max binding valueset. In most cases, this extension is used where the base binding is 'extensible'.


Use on Element ID ElementDefinition.binding

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: This acts as an overall 'required' binding for an element that already has a less restrictive binding. It is used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set that the codes must be drawn from is 'infinite'. The the base less restrictive binding SHALL be a proper subset of the max binding valueset. In most cases, this extension is used where the base binding is 'extensible'.


Use on Element ID ElementDefinition.binding
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"
... value[x] 1..1Value of extension
.... valueUriuri
.... valueCanonicalcanonical(ValueSet)

doco Documentation for this format

XML Template

<!-- maxValueSet -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 uri|canonical Value of extension --></value[x]>
</extension>

JSON Template

{ // maxValueSet
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", // R! 
  // value[x]: Value of extension. One of these 2:
    "valueUri" : "<uri>", // I R! Value of extension
    "valueCanonical" : "<canonical>" // I R! Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. maxValueSet0..1uri, canonical(ValueSet)URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: This acts as an overall 'required' binding for an element that already has a less restrictive binding. It is used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set that the codes must be drawn from is 'infinite'. The the base less restrictive binding SHALL be a proper subset of the max binding valueset. In most cases, this extension is used where the base binding is 'extensible'.


Use on Element ID ElementDefinition.binding

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: This acts as an overall 'required' binding for an element that already has a less restrictive binding. It is used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set that the codes must be drawn from is 'infinite'. The the base less restrictive binding SHALL be a proper subset of the max binding valueset. In most cases, this extension is used where the base binding is 'extensible'.


Use on Element ID ElementDefinition.binding
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"
... value[x] 1..1Value of extension
.... valueUriuri
.... valueCanonicalcanonical(ValueSet)

doco Documentation for this format

XML Template

<!-- maxValueSet -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 uri|canonical Value of extension --></value[x]>
</extension>

JSON Template

{ // maxValueSet
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", // R! 
  // value[x]: Value of extension. One of these 2:
    "valueUri" : "<uri>", // I R! Value of extension
    "valueCanonical" : "<canonical>" // I R! Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
  • ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension