Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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: maxValueSet

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
Version: 5.0.0-ballot
Name: maxValueSet
Title: null
Modifier: This extension is not a modifier extension
Status: draft
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'.
Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

The maximum allowable value set, for use when the This acts as an overall 'required' binding strength for an element that already has a less restrictive binding. It is 'extensible' or 'preferred'. This value set used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set from which additional that the codes can must be taken from. This defines a 'required' binding over drawn from is 'infinite'. The the top base less restrictive binding SHALL be a proper subset of the extensible binding. 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.

Context of Use: Use on Element ID ElementDefinition.binding

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . maxValueSet 0..1 uri , canonical ( ValueSet ) URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: The maximum allowable value set, for use when the This acts as an overall 'required' binding strength for an element that already has a less restrictive binding. It is 'extensible' or 'preferred'. This value set used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set from which additional that the codes can must be taken from. This defines a 'required' binding over drawn from is 'infinite'. The the top base less restrictive binding SHALL be a proper subset of the extensible binding. 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: The maximum allowable value set, for use when the This acts as an overall 'required' binding strength for an element that already has a less restrictive binding. It is 'extensible' or 'preferred'. This value set used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set from which additional that the codes can must be taken from. This defines a 'required' binding over drawn from is 'infinite'. The the top base less restrictive binding SHALL be a proper subset of the extensible binding. 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..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"
. . . value[x] 1..1 Value of extension
. . . . valueUri uri
. . . . valueCanonical canonical ( ValueSet )

doco Documentation for this format

XML Template 

<!-- maxValueSet -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet" >
  <!-- from Element: extension -->
 <</value[x]>

 <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

Name Flags Card. Type Description & Constraints doco
. . maxValueSet 0..1 uri , canonical ( ValueSet ) URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: The maximum allowable value set, for use when the This acts as an overall 'required' binding strength for an element that already has a less restrictive binding. It is 'extensible' or 'preferred'. This value set used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set from which additional that the codes can must be taken from. This defines a 'required' binding over drawn from is 'infinite'. The the top base less restrictive binding SHALL be a proper subset of the extensible binding. 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: The maximum allowable value set, for use when the This acts as an overall 'required' binding strength for an element that already has a less restrictive binding. It is 'extensible' or 'preferred'. This value set used when there is a desire to have a 'small' enumerable binding that meets most needs and where the overall value set from which additional that the codes can must be taken from. This defines a 'required' binding over drawn from is 'infinite'. The the top base less restrictive binding SHALL be a proper subset of the extensible binding. 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..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"
. . . value[x] 1..1 Value of extension
. . . . valueUri uri
. . . . valueCanonical canonical ( ValueSet )

doco Documentation for this format

XML Template 

<!-- maxValueSet -->doco

< xmlns="http://hl7.org/fhir"

<extension xmlns="http://hl7.org/fhir"

     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet" >
  <!-- from Element: extension -->
 <</value[x]>

 <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 unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters @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')]) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )

Search

No Search Extensions defined for this resource

Examples of this extension