FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3

Extension: inheritedExtensibleValueSet

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

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet

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

A reference to an extensible value set specified in a parent profie in order to allow a conformance checking tool to validate that a code not in the extensible value set of the profile is not violating rules defined by parent profile bindings.

Comment :

This extension is only needed where the binding strength is 'extensible', the parents are also 'extensible'. This allows a validator to work around the fact that restricting extensible value sets in child profiles loses constraints out of the parent profiles, (e.g. codes to be used when appropriate).

Context of Use: Use on data type: Element ID ElementDefinition.binding

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension inheritedExtensibleValueSet 0..* uri , Reference canonical ( ValueSet ) URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet
inheritedExtensibleValueSet: A reference to an extensible value set specified in a parent profie in order to allow a conformance checking tool to validate that a code not in the extensible value set of the profile is not violating rules defined by parent profile bindings.


Use on data type: Element ID ElementDefinition.binding

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet
inheritedExtensibleValueSet: A reference to an extensible value set specified in a parent profie in order to allow a conformance checking tool to validate that a code not in the extensible value set of the profile is not violating rules defined by parent profile bindings.


Use on data type: Element ID ElementDefinition.binding
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet" "http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet"
. . . value[x] I 1..1 Value of extension
.... valueUri uri , Reference ( ValueSet ) Value of extension
. . . . valueCanonical canonical (valueset.html)

doco Documentation for this format

XML Template 

<!-- inheritedExtensibleValueSet -->doco

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

 <value[x]><!-- ?? 1..1 uri|canonical Value of extension --></value[x]>

</extension>

JSON Template 

{ // inheritedExtensibleValueSet
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet", // R! 
// value[x]: Value of extension. One of these 2:
    "
    "

    "valueUri" : "<uri>" // C? R! Value of extension
    "valueCanonical" : "<canonical>", // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension inheritedExtensibleValueSet 0..* uri , Reference canonical ( ValueSet ) URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet
inheritedExtensibleValueSet: A reference to an extensible value set specified in a parent profie in order to allow a conformance checking tool to validate that a code not in the extensible value set of the profile is not violating rules defined by parent profile bindings.


Use on data type: Element ID ElementDefinition.binding

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet
inheritedExtensibleValueSet: A reference to an extensible value set specified in a parent profie in order to allow a conformance checking tool to validate that a code not in the extensible value set of the profile is not violating rules defined by parent profile bindings.


Use on data type: Element ID ElementDefinition.binding
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet" "http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet"
. . . value[x] I 1..1 Value of extension
.... valueUri uri , Reference ( ValueSet ) Value of extension
. . . . valueCanonical canonical (valueset.html)

doco Documentation for this format

XML Template 

<!-- inheritedExtensibleValueSet -->doco

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

 <value[x]><!-- ?? 1..1 uri|canonical Value of extension --></value[x]>

</extension>

JSON Template 

{ // inheritedExtensibleValueSet
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet", // R! 
// value[x]: Value of extension. One of these 2:
    "
    "

    "valueUri" : "<uri>" // C? R! Value of extension
    "valueCanonical" : "<canonical>", // C? R! 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')]) )
  • 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 )