FHIR Tooling Extensions IG
0.1.0 - Release International flag

This page is part of the HL7 Tools Extension IG (v0.1.0: Releases - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Extension: Additional Binding Extension

Official URL: http://hl7.org/fhir/tools/StructureDefinition/additional-binding Version: 0.1.0
Active as of 2023-12-19 Maturity Level: 4 Computable Name: AdditionalBinding

Extension definition for Additional Binding. Additional Bindings are in the R5 Element Definition; this extension is used in prior versions (instead of the R5 cross-version extension)

Context of Use

This extension may be used on the following element(s):

  • Element ID ElementDefinition.binding
  • Element ID CodeSystem.property

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: Extension definition for Additional Binding. Additional Bindings are in the R5 Element Definition; this extension is used in prior versions (instead of the R5 cross-version extension)

  • purpose: code: An Extension
  • valueSet: canonical: An Extension
  • documentation: markdown: An Extension
  • shortDoco: string: An Extension
  • usage: UsageContext: Definition of a context in which this binding applies. This SHOULD be present for purpose=conformance to limit the scope of the conformance claim.
  • any: boolean: An Extension

Maturity: 4

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAdditional Binding
... extension:purpose 1..1ExtensionHow the binding is used
.... extension 0..0
.... url 1..1uri"purpose"
.... value[x] 1..1codeValue of extension
Binding: Additional Binding Purpose ValueSet (required)
... extension:valueSet 1..1ExtensionThe valueSet for the binding
.... extension 0..0
.... url 1..1uri"valueSet"
.... value[x] 1..1canonical(ValueSet)Value of extension
... extension:documentation 0..1ExtensionDocumentation for this binding
.... extension 0..0
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
.... extension 0..0
.... url 1..1uri"shortDoco"
.... value[x] 1..1stringValue of extension
... extension:usage 0..1ExtensionDefinition of a context in which this binding applies
.... extension 0..0
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:any 0..1ExtensionWhether the binding applies to all repeats, or just to any one of the repeats
.... extension 0..0
.... url 1..1uri"any"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAdditional Binding
... id 0..1idUnique id for inter-element referencing
... Slices for extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:purpose 1..1ExtensionHow the binding is used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"purpose"
.... value[x] 1..1codeValue of extension
Binding: Additional Binding Purpose ValueSet (required)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"valueSet"
.... value[x] 1..1canonical(ValueSet)Value of extension
... extension:documentation 0..1ExtensionDocumentation for this binding
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
... extension:shortDoco 0..1ExtensionShort doco for this binding - used in dense table views
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"shortDoco"
.... value[x] 1..1stringValue of extension
... extension:usage 0..1ExtensionDefinition of a context in which this binding applies
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:any 0..1ExtensionWhether the binding applies to all repeats, or just to any one of the repeats
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"any"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/tools/StructureDefinition/additional-binding"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Extension definition for Additional Binding. Additional Bindings are in the R5 Element Definition; this extension is used in prior versions (instead of the R5 cross-version extension)

  • purpose: code: An Extension
  • valueSet: canonical: An Extension
  • documentation: markdown: An Extension
  • shortDoco: string: An Extension
  • usage: UsageContext: Definition of a context in which this binding applies. This SHOULD be present for purpose=conformance to limit the scope of the conformance claim.
  • any: boolean: An Extension

Maturity: 4

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAdditional Binding
... extension:purpose 1..1ExtensionHow the binding is used
.... extension 0..0
.... url 1..1uri"purpose"
.... value[x] 1..1codeValue of extension
Binding: Additional Binding Purpose ValueSet (required)
... extension:valueSet 1..1ExtensionThe valueSet for the binding
.... extension 0..0
.... url 1..1uri"valueSet"
.... value[x] 1..1canonical(ValueSet)Value of extension
... extension:documentation 0..1ExtensionDocumentation for this binding
.... extension 0..0
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
.... extension 0..0
.... url 1..1uri"shortDoco"
.... value[x] 1..1stringValue of extension
... extension:usage 0..1ExtensionDefinition of a context in which this binding applies
.... extension 0..0
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:any 0..1ExtensionWhether the binding applies to all repeats, or just to any one of the repeats
.... extension 0..0
.... url 1..1uri"any"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAdditional Binding
... id 0..1idUnique id for inter-element referencing
... Slices for extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:purpose 1..1ExtensionHow the binding is used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"purpose"
.... value[x] 1..1codeValue of extension
Binding: Additional Binding Purpose ValueSet (required)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"valueSet"
.... value[x] 1..1canonical(ValueSet)Value of extension
... extension:documentation 0..1ExtensionDocumentation for this binding
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"documentation"
.... value[x] 1..1markdownValue of extension
... extension:shortDoco 0..1ExtensionShort doco for this binding - used in dense table views
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"shortDoco"
.... value[x] 1..1stringValue of extension
... extension:usage 0..1ExtensionDefinition of a context in which this binding applies
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"usage"
.... value[x] 1..1UsageContextValue of extension
... extension:any 0..1ExtensionWhether the binding applies to all repeats, or just to any one of the repeats
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"any"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/tools/StructureDefinition/additional-binding"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:purpose.value[x]requiredAdditionalBindingPurposeVS (a valid code from Additional Binding Purpose Codes)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()