Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions .

Valueset-certainty-subcomponent-type.xml Extension: maxValueSet

Vocabulary FHIR Infrastructure Work Group   Maturity Level : N/A 1 Standards Status Trial Use Use Context : Informative 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

Raw 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

Name Flags Card. Type Description & Constraints doco
.. maxValueSet 0..1 uri , canonical form + also see XML Format Specification ( 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

Definition Full Structure

Name Flags Card. Type Description & Constraints doco
.. extension 0..1 Extension 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
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"
... value[x] 1..1 Value SetCertaintySubcomponentType of extension
.... valueUri uri
.... valueCanonical canonical ( ValueSet )

doco Documentation for this format

XML Template

<?xml version="1.0" encoding="UTF-8"?> 
<!-- maxValueSet -->doco


      
      
      
        Include all codes defined in 
          
            
          
        
      
    
  
  
    
  
  
    
  
  
    
  
  
  
    
    
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  
  
  
  
    
      
    
  

<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 </ ValueSet 

{ // 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: 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

Usage note: every effort Full Structure

Name Flags Card. Type Description & Constraints doco
.. extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
maxValueSet: This acts as an overall 'required' binding for an element that already has been made a less restrictive binding. It is used when there is a desire to ensure have a 'small' enumerable binding that the examples are correct meets most needs and useful, but they are not where the overall value set that the codes must be drawn from is 'infinite'. The the base less restrictive binding SHALL be a normative part proper subset of the specification. 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

<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